mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-11-05 13:26:48 +08:00
b45cbe929b
- Use path mappings in tsconfig.json to resolve module typings - Only use ambient mobules for global API's - Move single-file modules to a subdir with the same name so that we can provide a hand-written typing next to it (via package.json) - Delete all mentions of tns-core-modules.d.ts - Delete reference d.ts assembly build steps. Not needed anymore. - HACK! Use a <reference> for global typings in application.d.ts to avoid publishing a separate @types/tns-core-modules package. - Rename declarations.d.ts to tns-core-modules.d.ts to preserve JS project mappings in references.d.ts (the only place we use those)
153 lines
3.8 KiB
TypeScript
153 lines
3.8 KiB
TypeScript
/**
|
|
* Allows you to send web requests and receive the responses.
|
|
*/
|
|
import * as image from "image-source";
|
|
import * as fs from "file-system";
|
|
|
|
/**
|
|
* Downloads the content from the specified URL as a string.
|
|
* @param url The URL to request from.
|
|
*/
|
|
export function getString(url: string): Promise<string>;
|
|
|
|
/**
|
|
* Downloads the content from the specified URL as a string.
|
|
* @param options An object that specifies various request options.
|
|
*/
|
|
export function getString(options: HttpRequestOptions): 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.
|
|
*/
|
|
export function getJSON<T>(url: string): 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.
|
|
*/
|
|
export function getJSON<T>(options: HttpRequestOptions): Promise<T>;
|
|
|
|
/**
|
|
* Downloads the content from the specified URL and attempts to decode it as an image.
|
|
* @param url The URL to request from.
|
|
*/
|
|
export function getImage(url: string): 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.
|
|
*/
|
|
export function getImage(options: HttpRequestOptions): Promise<image.ImageSource>;
|
|
|
|
/**
|
|
* Downloads the content from the specified URL and attempts to save it as file.
|
|
* @param url The URL to request from.
|
|
* @param destinationFilePath Optional. The downloaded file path.
|
|
*/
|
|
export function getFile(url: string, destinationFilePath?: string): Promise<fs.File>;
|
|
|
|
/**
|
|
* Downloads the content from the specified URL and attempts to save it as file.
|
|
* @param options An object that specifies various request options.
|
|
* @param destinationFilePath Optional. The downloaded file path.
|
|
*/
|
|
export function getFile(options: HttpRequestOptions, destinationFilePath?: string): Promise<fs.File>;
|
|
|
|
/**
|
|
* Makes a generic http request using the provided options and returns a HttpResponse Object.
|
|
* @param options An object that specifies various request options.
|
|
*/
|
|
export function request(options: HttpRequestOptions): Promise<HttpResponse>;
|
|
|
|
/**
|
|
* Provides options for the http requests.
|
|
*/
|
|
export interface HttpRequestOptions {
|
|
/**
|
|
* Gets or sets the request url.
|
|
*/
|
|
url: string;
|
|
|
|
/**
|
|
* Gets or sets the request method.
|
|
*/
|
|
method: string;
|
|
|
|
/**
|
|
* Gets or sets the request headers in JSON format.
|
|
*/
|
|
headers?: any;
|
|
|
|
/**
|
|
* Gets or sets the request body.
|
|
*/
|
|
content?: string | FormData;
|
|
|
|
/**
|
|
* Gets or sets the request timeout in milliseconds.
|
|
*/
|
|
timeout?: number;
|
|
|
|
/**
|
|
* Gets or sets wether to *not* follow server's redirection responses.
|
|
*/
|
|
dontFollowRedirects?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Encapsulates HTTP-response information from an HTTP-request.
|
|
*/
|
|
export interface HttpResponse {
|
|
/**
|
|
* Gets the response status code.
|
|
*/
|
|
statusCode: number;
|
|
|
|
/**
|
|
* Gets the response headers.
|
|
*/
|
|
headers: Headers;
|
|
|
|
/**
|
|
* Gets the response content.
|
|
*/
|
|
content?: HttpContent;
|
|
}
|
|
|
|
export type Headers = { [key: string]: string | string[] };
|
|
|
|
export const enum HttpResponseEncoding {
|
|
UTF8,
|
|
GBK
|
|
}
|
|
/**
|
|
* Encapsulates the content of an HttpResponse.
|
|
*/
|
|
export interface HttpContent {
|
|
/**
|
|
* Gets the response body as raw data.
|
|
*/
|
|
raw: any;
|
|
|
|
/**
|
|
* Gets the response body as string.
|
|
*/
|
|
toString: (encoding?: HttpResponseEncoding) => string;
|
|
|
|
/**
|
|
* Gets the response body as JSON object.
|
|
*/
|
|
toJSON: (encoding?: HttpResponseEncoding) => any;
|
|
|
|
/**
|
|
* Gets the response body as ImageSource.
|
|
*/
|
|
toImage: () => Promise<image.ImageSource>;
|
|
|
|
/**
|
|
* Gets the response body as file.
|
|
*/
|
|
toFile: (destinationFilePath?: string) => fs.File;
|
|
}
|