It was moved to nativescript-core folder

Author: Ombuweb

Diff for: nativescript-core/http.md

@@ -0,0 +1,180 @@
+---
+title: Http
+---
+
+## Http
+
+The import for the Http module.
+
+```typescript
+import { Http } from '@nativescript/core'
+```
+
+### getString
+
+The `getString` method allows us to make a request and get the response body as a string value.
+
+```typescript
+import { Http } from '@nativescript/core'
+
+Http.getString('https://httpbin.org/get').then(
+  (result: string) => {
+    viewModel.set('getStringResult', r)
+  },
+  e => {}
+)
+```
+
+### getJSON
+
+The `getJSON` method gives us a simple way to get the response body as a JSON object.
+
+```typescript
+import { Http } from '@nativescript/core'
+
+Http.getJSON('https://httpbin.org/get').then(
+  (result: any) => {
+    console.log(result)
+  },
+  e => {}
+)
+```
+
+### getFile
+
+The `getFile` method allows us to download a file.
+
+```typescript
+import { Http } from '@nativescript/core'
+
+Http.getFile('https://d1lfyz5kwt8vu9.cloudfront.net/nativescript-logo-2021.png').then(
+  resultFile => {
+    // The returned result will be File object
+  },
+  e => {}
+)
+```
+
+::: warning Note
+By default the file will be saved in Documents folder.
+:::
+
+In the `getFile` method we could also specify the path, where the file to be saved. This scenario is demonstrated in the example below, where the image file will be kept in the current application folder.
+
+```typescript
+import { File, Http, knownFolders, path } from '@nativescript/core'
+
+const filePath: string = path.join(knownFolders.currentApp().path, 'test.png')
+
+Http.getFile(
+  'https://httpbin.org/image/png?testQuery=query&anotherParam=param',
+  filePath
+).then(
+  (resultFile: File) => {
+    // The returned result will be File object
+  },
+  e => {}
+)
+```
+
+### getImage
+
+The `getImage` method allows us to get an image from a specific URL. The returned object will be ImageSource and it could be used for direct displaying the source into Image view in your UI.
+
+```typescript
+import { Http, ImageSource } from '@nativescript/core'
+
+Http.getImage('https://httpbin.org/image/jpeg').then(
+  (r: ImageSource) => {
+    // getImage method returns ImageSource object
+  },
+  e => {}
+)
+```
+
+### request
+
+This example `request` method demonstrates how we can access the response headers, content, and statusCode.
+
+```typescript
+import { Http, HttpResponse } from '@nativescript/core'
+
+Http.request({
+  url: 'https://httpbin.org/get',
+  method: 'GET'
+}).then(
+  (response: HttpResponse) => {
+    // Argument (response) is HttpResponse
+    console.log(`Response Status Code: ${response.statusCode}`)
+    console.log(`Response Headers: ${response.statusCode}`)
+    console.log(`Response Content: ${response.content}`)
+  },
+  e => {}
+)
+```
+
+This example demonstrates, how to get the request-response content and how to represent the received data as a `String` value or `JSON` object. We could also use `toImage` method when we download an image.
+
+```typescript
+import { Http, HttpResponse } from '@nativescript/core'
+
+Http.request({
+  url: 'https://httpbin.org/get',
+  method: 'GET'
+}).then(
+  (response: HttpResponse) => {
+    // Content property of the response is HttpContent
+    const content = response.content
+
+    // The toString method allows you to get the response body as string.
+    const str = content.toString()
+
+    // The toJSON method allows you to parse the received content to JSON object
+    // var obj = content.toJSON();
+
+    // The toImage method allows you to get the response body as ImageSource.
+    // var img = response.content.toImage();
+  },
+  e => {}
+)
+```
+
+#### Post
+
+The example demonstrates, how to make Http POST request and how to get request response.
+
+```typescript
+import { Http, HttpResponse } from "@nativescript/core";
+
+Http.request({
+  url: "https://httpbin.org/post",
+  method: "POST",
+  headers: { "Content-Type": "application/json" },
+  content: JSON.stringify({
+    username: "[email protected],
+    password: "someEncryptedPasswordValue",
+  }),
+}).then(
+  (response: HttpResponse) => {
+    const result = response.content.toJSON();
+    console.log(`Http POST Result: ${result}`)
+  },
+  (e) => {}
+);
+```
+
+#### Methods
+
+| Name                                                                | Type                    | Description                                                                                         |
+| ------------------------------------------------------------------- | ----------------------- | --------------------------------------------------------------------------------------------------- |
+| `getFile(url: string, destinationFilePath?: string): Promise<File>` | `Promise<File>`         | Downloads the content from the specified URL and attempts to save it as file.                       |
+| `getImage(url: string): Promise<ImageSource>`                       | `Promise<ImageSource>`  | Downloads the content from the specified URL and attempts to decode it as an image.                 |
+| `getJSON<T>(url: string): Promise<T>`                               | `Promise<T>`            | Downloads the content from the specified URL as a string and returns its JSON.parse representation. |
+| `getString(url: string): Promise<string>`                           | `Promise<string>`       | Downloads the content from the specified URL as a string.                                           |
+| `request(options: HttpRequestOptions): Promise<HttpResponse>`       | `Promise<HttpResponse>` | Makes a generic http request using the provided options and returns a HttpResponse Object.          |
+
+#### API References
+
+| Name                                                                                     | Type     |
+| ---------------------------------------------------------------------------------------- | -------- |
+| [@nativescript/core/http](https://docs.nativescript.org/api-reference/modules.html#http) | `Module` |