readme/doc

Author: farfromrefug

README.md

@@ -20,7 +20,7 @@
       !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <h1 align="center">@nativescript-community/https</h1>
 <p align="center">
-		<a href="https://npmcharts.com/compare/@nativescript-community/https?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/https.svg" height="20"/></a>
+		<a href="https://npmcharts.com/compare/@nativescript-community/https?minimal=true"><img alt="Downloads per month" src="https://img.shields.io/npm/dm/@nativescript-community/https.svg" height="20"/></a>
 <a href="https://www.npmjs.com/package/@nativescript-community/https"><img alt="NPM Version" src="https://img.shields.io/npm/v/@nativescript-community/https.svg" height="20"/></a>
 	</p>
 
@@ -32,53 +32,53 @@
 <br />
 
 
-
-[](#table-of-contents)
-
-
-[](#table-of-contents)
-
+
+[](#table-of-contents)
+
+
+[](#table-of-contents)
+
 ## Table of Contents
 
-	* [Installation](#installation)
-			* [A drop-in replacement for the [default http module](https://docs.nativescript.org/cookbook/http).](#a-drop-in-replacement-for-the-default-http-modulehttpsdocsnativescriptorgcookbookhttp)
-	* [Features](#features)
-	* [FAQ](#faq)
-	* [Installation](#installation-1)
-	* [Examples](#examples)
-		* [Hitting an API using `GET` method](#hitting-an-api-using-get-method)
-	* [Configuration](#configuration)
-		* [Installing your SSL certificate](#installing-your-ssl-certificate)
-			* [Enabling SSL pinning](#enabling-ssl-pinning)
-			* [Disabling SSL pinning](#disabling-ssl-pinning)
-		* [useLegacy](#uselegacy)
-		* [Cookie](#cookie)
-		* [Enabling Cache](#enabling-cache)
-		* [Multipart form data](#multipart-form-data)
-		* [Options](#options)
-	* [Webpack / bundling](#webpack--bundling)
-	* [`iOS` Troubleshooting](#ios-troubleshooting)
-	* [`Android` troubleshooting](#android-troubleshooting)
-* [Thanks](#thanks)
-		* [Examples:](#examples-1)
-	* [Demos and Development](#demos-and-development)
-		* [Repo Setup](#repo-setup)
-		* [Build](#build)
-		* [Demos](#demos)
-	* [Contributing](#contributing)
-		* [Update repo ](#update-repo-)
-		* [Update readme ](#update-readme-)
-		* [Update doc ](#update-doc-)
-		* [Publish](#publish)
-		* [modifying submodules](#modifying-submodules)
+	* [Installation](#installation)
+			* [A drop-in replacement for the [default http module](https://docs.nativescript.org/cookbook/http).](#a-drop-in-replacement-for-the-default-http-modulehttpsdocsnativescriptorgcookbookhttp)
+	* [Features](#features)
+	* [FAQ](#faq)
+	* [Installation](#installation-1)
+	* [Examples](#examples)
+		* [Hitting an API using `GET` method](#hitting-an-api-using-get-method)
+	* [Configuration](#configuration)
+		* [Installing your SSL certificate](#installing-your-ssl-certificate)
+			* [Enabling SSL pinning](#enabling-ssl-pinning)
+			* [Disabling SSL pinning](#disabling-ssl-pinning)
+		* [useLegacy](#uselegacy)
+		* [Cookie](#cookie)
+		* [Enabling Cache](#enabling-cache)
+		* [Multipart form data](#multipart-form-data)
+		* [Options](#options)
+	* [Webpack / bundling](#webpack--bundling)
+	* [`iOS` Troubleshooting](#ios-troubleshooting)
+	* [`Android` troubleshooting](#android-troubleshooting)
+* [Thanks](#thanks)
+		* [Examples:](#examples-1)
+	* [Demos and Development](#demos-and-development)
+		* [Repo Setup](#repo-setup)
+		* [Build](#build)
+		* [Demos](#demos)
+	* [Contributing](#contributing)
+		* [Update repo ](#update-repo-)
+		* [Update readme ](#update-readme-)
+		* [Update doc ](#update-doc-)
+		* [Publish](#publish)
+		* [modifying submodules](#modifying-submodules)
 	* [Questions](#questions)
 
-
-[](#installation)
-
-
-[](#installation)
-
+
+[](#installation)
+
+
+[](#installation)
+
 ## Installation
 Run the following command from the root of your project:
 
@@ -92,12 +92,12 @@ Easily integrate the most reliable native networking libraries with the latest a
 
 #### A drop-in replacement for the [default http module](https://docs.nativescript.org/cookbook/http).
 
-
-[](#features)
-
-
-[](#features)
-
+
+[](#features)
+
+
+[](#features)
+
 ## Features
 
 -   Modern TLS & SSL security features
@@ -110,12 +110,12 @@ Easily integrate the most reliable native networking libraries with the latest a
 -   Cache
 -   Basic Cookie support
 
-
-[](#faq)
-
-
-[](#faq)
-
+
+[](#faq)
+
+
+[](#faq)
+
 ## FAQ
 
 > What the flip is SSL pinning and all this security mumbo jumbo?
@@ -127,24 +127,24 @@ Easily integrate the most reliable native networking libraries with the latest a
 **No.** This plugin works out of the box without any security configurations needed. Either way you'll still benefit from all the features listed above.
 
 
-
-[](#installation)
-
-
-[](#installation)
-
+
+[](#installation)
+
+
+[](#installation)
+
 ## Installation
 
 ```bash
 tns plugin add @nativescript-community/https
 ```
 
-
-[](#examples)
-
-
-[](#examples)
-
+
+[](#examples)
+
+
+[](#examples)
+
 ## Examples
 
 ### Hitting an API using `GET` method
@@ -164,12 +164,12 @@ Https.request({
     });
 ```
 
-
-[](#configuration)
-
-
-[](#configuration)
-
+
+[](#configuration)
+
+
+[](#configuration)
+
 ## Configuration
 
 ### Installing your SSL certificate
@@ -273,23 +273,23 @@ export interface HttpsRequestOptions extends HTTPOptions {
 | `cachePolicy?: 'noCache'                                | 'onlyCache'                                                                                                                                                  | 'ignoreCache'` | Set the cache policy to use with that request. This only works with GET requests for now. |
 | `onProgress?: (current: number, total: number) => void` | [IOS only] Set the progress callback.                                                                                                                        |
 
-
-[](#webpack--bundling)
-
-
-[](#webpack--bundling)
-
+
+[](#webpack--bundling)
+
+
+[](#webpack--bundling)
+
 ## Webpack / bundling
 
 Since you're probably shipping a certificate with your app (like [our demo does](https://github.com/nativescript-community/https/tree/master/demo/app/assets)),
 make sure it's bundled by Webpack as well. You can do this by [adding the certificate(s) with the `CopyWebpackPlugin`](https://github.com/nativescript-community/https/blob/a5c841c0af7ff6d9994fa23f7fba0df0514c58f1/demo/webpack.config.js#L240).
 
-
-[](#ios-troubleshooting)
-
-
-[](#ios-troubleshooting)
-
+
+[](#ios-troubleshooting)
+
+
+[](#ios-troubleshooting)
+
 ## `iOS` Troubleshooting
 
 > ### Please educate yourself on iOS's [App Transport Security](https://github.com/codepath/ios_guides/wiki/App-Transport-Security) before starting beef!
@@ -307,24 +307,23 @@ You can bypass this behavior by adding the following to your projects `Info.plis
 
 > This plugin **does not** add `NSAllowsArbitraryLoads` to your projects `Info.plist` for you.
 
-
-[](#android-troubleshooting)
-
-
-[](#android-troubleshooting)
-
+
+[](#android-troubleshooting)
+
+
+[](#android-troubleshooting)
+
 ## `Android` troubleshooting
 
-* If you app crashes with a message that it's doing too much networking on the main thread,
+If you app crashes with a message that it's doing too much networking on the main thread,
 then pass the option `allowLargeResponse` with value `true` to the `request` function.
-* When using `useLegacy` (which is the default) `content.toString()` and `content.toJSON()` might throw `android.os.NetworkOnMainThreadException` if called from the main thread (seems to depend on response headers). Either call those from a background thread or use `content.toStringAsync()` or `content.toJSONAsync()`
-* once you've called `content.[toString,toStringAsync,toJSON,toJSONAsync,...]` the response is closed and will throw `java.lang.IllegalStateException: closed` if called again. So choose the right one and only call once. The reason is that we need to close the response so that you dont have too.
-
-[](#thanks)
-
-
-[](#thanks)
 
+
+[](#thanks)
+
+
+[](#thanks)
+
 # Thanks
 
 | Who                                             | Why                                                                                                                                                               |
@@ -340,12 +339,12 @@ then pass the option `allowLargeResponse` with value `true` to the `request` fun
 - [Basic](demo-snippets/vue/Basic.vue)
   - A basic example
 
-
-[](#demos-and-development)
-
-
-[](#demos-and-development)
-
+
+[](#demos-and-development)
+
+
+[](#demos-and-development)
+
 ## Demos and Development
 
 
@@ -385,12 +384,12 @@ Demo setup is a bit special in the sense that if you want to modify/add demos yo
 Instead you work in `demo-snippets/[ng|react|svelte|vue]`
 You can start from the `install.ts` of each flavor to see how to register new demos 
 
-
-[](#contributing)
-
-
-[](#contributing)
-
+
+[](#contributing)
+
+
+[](#contributing)
+
 ## Contributing
 
 ### Update repo 
@@ -438,18 +437,18 @@ One easy solution is t modify `~/.gitconfig` and add
 	pushInsteadOf = https://github.com/
 ```
 
-
-[](#questions)
-
-
-[](#questions)
-
+
+[](#questions)
+
+
+[](#questions)
+
 ## Questions
 
 If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
-
-[](#demos-and-development)
-
+
+[](#demos-and-development)
+
 ## Demos and Development
 
 
@@ -489,9 +488,9 @@ Demo setup is a bit special in the sense that if you want to modify/add demos yo
 Instead you work in `demo-snippets/[ng|react|svelte|vue]`
 You can start from the `install.ts` of each flavor to see how to register new demos 
 
-
-[](#contributing)
-
+
+[](#contributing)
+
 ## Contributing
 
 ### Update repo 
@@ -538,9 +537,9 @@ One easy solution is t modify `~/.gitconfig` and add
 [url "ssh://[email protected]/"]
 	pushInsteadOf = https://github.com/
 ```
-
-[](#questions)
-
+
+[](#questions)
+
 ## Questions
 
 If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).