javascript/NativeScript
1
0
Fork 0
mirror of https://github.com/NativeScript/NativeScript.git synced 2025-11-05 13:26:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated API reference.

Browse Source
This commit is contained in:
atanasovg
2014-05-22 11:46:52 +03:00
parent 5c82a6d67a
commit 87f7847155
4 changed files with 75 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
http/http.d.ts vendored
View File

@@ -1,17 +1,47 @@

declare module "http" {
declare module "http" {
import image = require("image-source");
import promises = require("promises");
/**
* Downloads the content from the specified URL as a string.
* @param url The URL to request from.
*/
function getString(url: string): promises.Promise<string>
/**
* Downloads the content from the specified URL as a string.
* @param options An object that specifies various request options.
*/
function getString(options: HttpRequestOptions): promises.Promise<string>
/**
* Downloads the content from the specified URL as a string and returns its JSON.parse representation.
* @param url The URL to request from.
*/
function getJSON<T>(url: string): promises.Promise<T>
/**
* Downloads the content from the specified URL as a string and returns its JSON.parse representation.
* @param options An object that specifies various request options.
*/
function getJSON<T>(options: HttpRequestOptions): promises.Promise<T>
/**
* Downloads the content from the specified URL and attempts to decode it as an image.
* @param url The URL to request from.
*/
function getImage(url: string): promises.Promise<image.ImageSource>
/**
* Downloads the content from the specified URL and attempts to decode it as an image.
* @param options An object that specifies various request options.
*/
function getImage(options: HttpRequestOptions): promises.Promise<image.ImageSource>
/**
* Makes a generic http request using the provided options and returns a HttpResponse Object.
* @param options An object that specifies various request options.
*/
function request(options: HttpRequestOptions): promises.Promise<HttpResponse>;
interface HttpRequestOptions {
@@ -31,6 +61,7 @@ declare module "http" {
interface HttpContent {
raw: any;
toString: () => string;
// TODO: Isn't parseJSON better naming? toJSON sounds to me like we will return a string object
toJSON: () => any;
toImage: () => image.ImageSource;
}