${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/functions/cancelAllRequests.html b/docs/functions/cancelAllRequests.html
new file mode 100644
index 0000000..6d81a0a
--- /dev/null
+++ b/docs/functions/cancelAllRequests.html
@@ -0,0 +1 @@
+
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-
-Function createRequest
-
-
- create
Request(opts: HttpsRequestOptions): HttpsRequest
- -
---
Parameters
--
-
-
-
opts: HttpsRequestOptions
Returns HttpsRequest
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function createRequest
Parameters
- opts: HttpsRequestOptions
Returns HttpsRequest
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-
-Function enableSSLPinning
-
-
- enableSSLPinning(options: HttpsSSLPinningOptions): any -
-
---
Parameters
--
-
-
-
options: HttpsSSLPinningOptions
Returns any
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function enableSSLPinning
Parameters
- options: HttpsSSLPinningOptions
Returns any
-
-
-
-
-
-
-
-Function getBinary
-
-
- get
Binary(arg: string | HttpsRequestOptions): Promise<ArrayBuffer>
- -
---
Parameters
--
-
-
-
arg: string | HttpsRequestOptions
-either The URL to request from or HttpsRequestOptions options.
-
Returns Promise<ArrayBuffer>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getBinary
Downloads the content from the specified URL as binary and returns an ArrayBuffer.
+Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
+
Returns Promise<ArrayBuffer>
- arg: string | HttpsRequestOptions
-
-
-
-
-
-
-
-Function getClient
-
-
- get
Client(opts: Partial<HttpsRequestOptions>): any
- -
---
Parameters
--
-
-
-
opts: Partial<HttpsRequestOptions>
Returns any
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getClient
Parameters
- opts: Partial<HttpsRequestOptions>
Returns any
-
-
-
-
-
-
-
-Function getFile
-
-
- get
File(arg: string | HttpsRequestOptions, destinationFilePath?: string): Promise<any>
- -
--
Downloads the content from the specified URL and attempts to save it as file.
---Parameters
--
-
-
-
arg: string | HttpsRequestOptions
-either The URL to request from or HttpsRequestOptions options.
-
- -
-
-OptionaldestinationFilePath: stringOptional. The downloaded file path.
-
Returns Promise<any>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getFile
Downloads the content from the specified URL and attempts to save it as file.
+Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
+ OptionaldestinationFilePath: stringOptional. The downloaded file path.
+
Returns Promise<any>
- arg: string | HttpsRequestOptions
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
diff --git a/docs/functions/getImage.html b/docs/functions/getImage.html
index 58eadfa..f2e71a0 100644
--- a/docs/functions/getImage.html
+++ b/docs/functions/getImage.html
@@ -1,88 +1,3 @@
-
-
-
-
-
-
-
-
-Function getImage
-
-
- get
Image(arg: string | HttpsRequestOptions): Promise<ImageSource>
- -
--
Downloads the content from the specified URL and attempts to decode it as an image.
---Parameters
--
-
-
-
arg: string | HttpsRequestOptions
-either The URL to request from or HttpsRequestOptions options.
-
Returns Promise<ImageSource>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getImage
Downloads the content from the specified URL and attempts to decode it as an image.
+Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
+
Returns Promise<ImageSource>
- arg: string | HttpsRequestOptions
-
-
-
-
-
-
-
-Function getJSON
-
-
- getJSON<T>(arg: string | HttpsRequestOptions): Promise<T> -
-
--
Downloads the content from the specified URL as a string and returns its JSON.parse representation.
-- -Type Parameters
--
-
-
-
T
--Parameters
--
-
-
-
arg: string | HttpsRequestOptions
-either The URL to request from or HttpsRequestOptions options.
-
Returns Promise<T>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getJSON
Downloads the content from the specified URL as a string and returns its JSON.parse representation.
+Type Parameters
- T
Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
+
Returns Promise<T>
-
-
-
-
-
-
-
-Function getString
-
-
- get
String(arg: string | HttpsRequestOptions): Promise<string>
- -
--
Downloads the content from the specified URL as a string.
---Parameters
--
-
-
-
arg: string | HttpsRequestOptions
-either The URL to request from or HttpsRequestOptions options.
-
Returns Promise<string>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function getString
Downloads the content from the specified URL as a string.
+Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
+
Returns Promise<string>
- arg: string | HttpsRequestOptions
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-
-Function request
-
-
- request<T, U>(options: HttpsRequestOptions, useLegacy?: U): U extends true ? Promise<HttpsResponse<HttpsResponseLegacy<T>>> : Promise<HttpsResponse<T>> -
-
-
- -Type Parameters
--
-
-
-
T = any
- -
-
U extends boolean = true
--Parameters
--
-
-
-
options: HttpsRequestOptions
- -
-
OptionaluseLegacy: U
Returns U extends true ? Promise<HttpsResponse<HttpsResponseLegacy<T>>> : Promise<HttpsResponse<T>>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function request
- request<T = any, U extends boolean = true>(
options: HttpsRequestOptions,
useLegacy?: U,
): U extends true
? Promise<HttpsResponse<HttpsResponseLegacy<T>>>
: Promise<HttpsResponse<T>>Type Parameters
- T = any
- U extends boolean = true
Parameters
- options: HttpsRequestOptions
OptionaluseLegacy: U
Returns U extends true
? Promise<HttpsResponse<HttpsResponseLegacy<T>>>
: Promise<HttpsResponse<T>>
-
-
-
-
-
-
-
-Function setCache
-
-
- set
Cache(options?: CacheOptions): any
- -
---
Parameters
--
-
-
-
Optionaloptions: CacheOptions
Returns any
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function setCache
Parameters
Optionaloptions: CacheOptions
Returns any
Nativescript plugin for https requests
Hierarchy Summary
-
diff --git a/docs/interfaces/CacheOptions.html b/docs/interfaces/CacheOptions.html
index f6f4b18..a7f7af1 100644
--- a/docs/interfaces/CacheOptions.html
+++ b/docs/interfaces/CacheOptions.html
@@ -1,88 +1,5 @@
-
-
-
-Nativescript plugin for https requests
+Nativescript plugin for https requests
- - - - - -
-
-
Nativescript plugin for https requests
@nativescript-community/https
- 
+
-
Nativescript plugin for https requests
-- - - - - -
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)
+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
- * Examples:
-- Demos and Development
+* Examples:
+
+- Demos and Development
+
-- Contributing
+- Contributing
+
- Update repo
- Update readme
- Update doc
@@ -78,11 +76,7 @@ Table of Contents
-
-
- Installation
-
-Run the following command from the root of your project:
+Installation
Run the following command from the root of your project:
ns plugin add @nativescript-community/https
Easily integrate the most reliable native networking libraries with the latest and greatest HTTPS security features.
@@ -91,17 +85,9 @@ Installation
Plugin version 2.0.0 bumps AFNetworking on iOS to 4.0.0 which no longer relies on UIWebView. Make sure to run pod repo update to get the latest AFNetworking pod on your development machine.
-
-
- A drop-in replacement for the default http module.
-
+A drop-in replacement for the default http module.
-
-
-
- Features
-
-
+Features
- Modern TLS & SSL security features
- Shared connection pooling reduces request latency
- Silently recovers from common connection problems
@@ -114,100 +100,55 @@ Features
-
-
- FAQ
-
-
+FAQ
What the flip is SSL pinning and all this security mumbo jumbo?
How to make your apps more secure with SSL pinning.
Do I have to use SSL pinning?
-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.
+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
tns plugin add @nativescript-community/https
+
-
- Installation
-
-tns plugin add @nativescript-community/https
-
+Examples
Hitting an API using GET method
import * as Https from '@nativescript-community/https';
Https.request({
url: 'https://httpbin.org/get',
method: 'GET',
timeout: 30, // seconds (default 10)
})
.then(function (response) {
console.log('Https.request response', response);
})
.catch(function (error) {
console.error('Https.request error', error);
});
+
-
- Examples
-
-
-
- Hitting an API using GET method
-
-import * as Https from '@nativescript-community/https';
Https.request({
url: 'https://httpbin.org/get',
method: 'GET',
timeout: 30, // seconds (default 10)
})
.then(function (response) {
console.log('Https.request response', response);
})
.catch(function (error) {
console.error('Https.request error', error);
});
-
-
-
- Configuration
-
-
-
- Installing your SSL certificate
-
-Create a folder called assets in your projects app folder like so <project>/app/assets. Using chrome, go to the URL where the SSL certificate resides. View the details then drag and drop the certificate image into the assets folder.
+Configuration
Installing your SSL certificate
Create a folder called assets in your projects app folder like so <project>/app/assets. Using chrome, go to the URL where the SSL certificate resides. View the details then drag and drop the certificate image into the assets folder.
+Enabling SSL pinning
import { knownFolders } from 'file-system';
import * as Https from '@nativescript-community/https';
let dir = knownFolders.currentApp().getFolder('assets');
let certificate = dir.getFile('httpbin.org.cer').path;
Https.enableSSLPinning({ host: 'httpbin.org', certificate });
+
-
- Enabling SSL pinning
-
-import { knownFolders } from 'file-system';
import * as Https from '@nativescript-community/https';
let dir = knownFolders.currentApp().getFolder('assets');
let certificate = dir.getFile('httpbin.org.cer').path;
Https.enableSSLPinning({ host: 'httpbin.org', certificate });
-
-Once you've enabled SSL pinning you CAN NOT re-enable with a different host or certificate file.
+Once you've enabled SSL pinning you CAN NOT re-enable with a different host or certificate file.
+Disabling SSL pinning
import * as Https from '@nativescript-community/https';
Https.disableSSLPinning();
+
-
- Disabling SSL pinning
-
-import * as Https from '@nativescript-community/https';
Https.disableSSLPinning();
-
All requests after calling this method will no longer utilize SSL pinning until it is re-enabled once again.
-
-
- useLegacy
-
-There is a new option called useLegacy. You can set of every request options.
+
useLegacy
There is a new option called useLegacy. You can set of every request options.
When using that option the request will behave more like {N} http module.
- the
content returned by a request is not the resulting string but an object. It follows HTTPContent format for the most part. You can call toJSON or toFile. The only difference is that toFile returns a Promise<File> which means that it is async and run in a background thread!
- an error return a
content too allowing you to read its content.
-
-
- Cookie
-
-By default basic Cookie support is enabled to work like in {N} http module.
+
Cookie
By default basic Cookie support is enabled to work like in {N} http module.
In the future more options will be added
+Enabling Cache
import { knownFolders, path } from '@nativescript/core/file-system';
import * as Https from '@nativescript-community/https';
Https.setCache({
diskLocation: path.join(knownFolders.documents().path, 'httpcache'),
diskSize: 10 * 1024 * 1024, // 10 MiB
});
/// later on when calling your request you can use the cachePolicy option
+
-
- Enabling Cache
-
-import { knownFolders, path } from '@nativescript/core/file-system';
import * as Https from '@nativescript-community/https';
Https.setCache({
diskLocation: path.join(knownFolders.documents().path, 'httpcache'),
diskSize: 10 * 1024 * 1024, // 10 MiB
});
/// later on when calling your request you can use the cachePolicy option
-
+Multipart form data
If you set the Content-Type header to "multipart/form-data" the request body will be evaluated as a multipart form data. Each body parameter is expected to be in this format:
+{
data: any
parameterName: string,
fileName?: string
contentType?: string
}
+
-
- Multipart form data
-
-If you set the Content-Type header to "multipart/form-data" the request body will be evaluated as a multipart form data. Each body parameter is expected to be in this format:
-{
data: any
parameterName: string,
fileName?: string
contentType?: string
}
-
if fileName and contentType are set then data is expected to be either a NSData on iOS or a native.Array<number> on Android.
+Options
export interface HttpsSSLPinningOptions {
host: string;
certificate: string;
allowInvalidCertificates?: boolean;
validatesDomainName?: boolean;
commonName?: string;
}
import { HttpRequestOptions } from 'tns-core-modules/http';
export interface HttpsRequestOptions extends HTTPOptions {
useLegacy?: boolean;
cachePolicy?: 'noCache' | 'onlyCache' | 'ignoreCache';
onProgress?: (current: number, total: number) => void;
}
+
-
- Options
-
-export interface HttpsSSLPinningOptions {
host: string;
certificate: string;
allowInvalidCertificates?: boolean;
validatesDomainName?: boolean;
commonName?: string;
}
import { HttpRequestOptions } from 'tns-core-modules/http';
export interface HttpsRequestOptions extends HTTPOptions {
useLegacy?: boolean;
cachePolicy?: 'noCache' | 'onlyCache' | 'ignoreCache';
onProgress?: (current: number, total: number) => void;
}
-
@@ -215,7 +156,8 @@ Options
Description
-
+
+
host: stringThis must be the request domain name eg sales.company.org.
@@ -229,13 +171,14 @@ Options
allowInvalidCertificates?: booleanDefault: false. This should always be false if you are using SSL pinning. Set this to true if you're using a self-signed certificate.
+Default: false. This should always be false if you are using SSL pinning. Set this to true if you're using a self-signed certificate.
validatesDomainName?: booleanDefault: true. Determines if the domain name should be validated with your pinned certificate.
-
+
+
@@ -243,68 +186,56 @@ Options
Description
-
+
+
useLegacy?: booleanDefault: false. [IOS only] set to true in order to get the response data (when status >= 300)in the content directly instead of response.body.content.
-`cachePolicy?: 'noCache'
-'onlyCache'
+`cachePolicy?: 'noCache'
+'onlyCache'
onProgress?: (current: number, total: number) => void[IOS only] Set the progress callback.
-
+
+
-
-
- Webpack / bundling
-
-Since you're probably shipping a certificate with your app (like our demo does),
-make sure it's bundled by Webpack as well. You can do this by adding the certificate(s) with the CopyWebpackPlugin.
+Webpack / bundling
Since you're probably shipping a certificate with your app (like our demo does),
+make sure it's bundled by Webpack as well. You can do this by adding the certificate(s) with the CopyWebpackPlugin.
-
-
- iOS Troubleshooting
-
-
-
-
- Please educate yourself on iOS's App Transport Security before starting beef!
-
-
-If you try and hit an https route without adding it to App Transport Security's whitelist it will not work!
+
iOS Troubleshooting
+Please educate yourself on iOS's App Transport Security before starting beef!
+If you try and hit an https route without adding it to App Transport Security's whitelist it will not work!
You can bypass this behavior by adding the following to your projects Info.plist:
-<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
-
+NSAppTransportSecurity
+
+ NSAllowsArbitraryLoads
+
+
+
This plugin does not add NSAllowsArbitraryLoads to your projects Info.plist for you.
-
-
- Android troubleshooting
-
-If you app crashes with a message that it's doing too much networking on the main thread,
+
Android troubleshooting
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.
-
-
- Thanks
-
-
+Thanks
Who
Why
-
+
+
Robert Laverty
For creating and maintaining this plugin for a long time
@@ -324,159 +255,118 @@ Thanks
Square
okhttp An HTTP+HTTP/2 client for Android and Java applications.
-
-
-
- Examples:
-
+
+
+Examples:
+- Basic
-- Basic
- A basic example
+Demos and Development
Repo Setup
The repo uses submodules. If you did not clone with --recursive then you need to call
+git submodule update --init
+
-
- Demos and Development
-
-
-
- Repo Setup
-
-The repo uses submodules. If you did not clone with --recursive then you need to call
-git submodule update --init
-
The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.
To develop and test:
if you use yarn then run yarn
if you use pnpm then run pnpm i
Interactive Menu:
To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.
+Build
npm run build.all
+
-
- Build
-
-npm run build.all
-
WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run
+Demos
npm run demo.[ng|react|svelte|vue].[ios|android]
npm run demo.svelte.ios # Example
+
-
- Demos
-
-npm run demo.[ng|react|svelte|vue].[ios|android]
npm run demo.svelte.ios # Example
-
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue]
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
+You can start from the install.ts of each flavor to see how to register new demos
-
-
- Contributing
-
-
-
- Update repo
-
-You can update the repo files quite easily
+Contributing
Update repo
You can update the repo files quite easily
First update the submodules
-npm run update
-
+npm run update
+
+
Then commit the changes
Then update common files
-npm run sync
-
+npm run sync
+
+
Then you can run yarn|pnpm, commit changed files if any
+Update readme
npm run readme
+
-
- Update readme
-
-npm run readme
-
+Update doc
npm run doc
+
-
- Update doc
-
-npm run doc
-
+Publish
The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
+Simply run
+npm run publish
+
-
- Publish
-
-The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
-Simply run
-npm run publish
-
-
-
- modifying submodules
-
-The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
+
modifying submodules
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
One easy solution is t modify ~/.gitconfig and add
-[url "ssh://git@github.com/"]
pushInsteadOf = https://github.com/
-
+[url "ssh://git@github.com/"]
pushInsteadOf = https://github.com/
+
+
+Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
+
+Demos and Development
Repo Setup
The repo uses submodules. If you did not clone with --recursive then you need to call
+git submodule update --init
+
-
- Questions
-
-If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
The package manager used to install and link dependencies must be pnpm or yarn. npm wont work.
To develop and test:
+if you use yarn then run yarn
+if you use pnpm then run pnpm i
Interactive Menu:
+To start the interactive menu, run npm start (or yarn start or pnpm start). This will list all of the commonly used scripts.
Build
npm run build.all
+WARNING: it seems yarn build.all wont always work (not finding binaries in node_modules/.bin) which is why the doc explicitly uses npm run
Demos
npm run demo.[ng|react|svelte|vue].[ios|android]
npm run demo.svelte.ios # Example
+Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in demo-[ng|react|svelte|vue]
+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
Update repo
You can update the repo files quite easily
+First update the submodules
+npm run update
+Then commit the changes +Then update common files
+npm run sync
+Then you can run yarn|pnpm, commit changed files if any
Update readme
npm run readme
+Update doc
npm run doc
+Publish
The publishing is completely handled by lerna (you can add -- --bump major to force a major release)
+Simply run
npm run publish
+modifying submodules
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
+One easy solution is t modify ~/.gitconfig and add
[url "ssh://git@github.com/"]
pushInsteadOf = https://github.com/
+Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
+
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface CacheOptions
interface CacheOptions {
diskLocation: string;
diskSize: number;
forceCache?: boolean;
memorySize?: number;
}
diskLocation: string;
diskSize: number;
forceCache?: boolean;
memorySize?: number;
}
Index
Properties
-
-
-
-
-
-
-
-
-
-Interface Headers
Hierarchy
--
-
- Headers
Indexable
-[k: string]: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface Headers
Indexable
- [k: string]: string
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface HttpsFormDataParam
interface HttpsFormDataParam {
contentType?: string;
data: any;
fileName?: string;
parameterName: string;
}
contentType?: string;
data: any;
fileName?: string;
parameterName: string;
}
Index
Properties
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface HttpsRequest
Index
Properties
Methods
-
-
-
-
-
-
-
-
-
-Interface HttpsRequestObject
Hierarchy
--
-
- HttpsRequestObject
Indexable
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface HttpsRequestObject
Indexable
-
diff --git a/docs/interfaces/HttpsResponse.html b/docs/interfaces/HttpsResponse.html
index fdc6715..a1a0849 100644
--- a/docs/interfaces/HttpsResponse.html
+++ b/docs/interfaces/HttpsResponse.html
@@ -1,121 +1,10 @@
-
-
-
-
-
-
-
-
-
-
-
-HttpsRequestOptions | Nativescript plugin for https requests
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface HttpsRequestOptions
Hierarchy
--
-
- HttpRequestOptions
-
-
-
- HttpsRequestOptions
- Index
-
-
-
Properties
-Properties
-Optional allow
-allow
-On Android large responses may crash the app (fi. https://httpbin.org/bytes/10000). +
Interface HttpsRequestOptions
interface HttpsRequestOptions {
allowLargeResponse?: boolean;
body?: HttpsRequestObject | HttpsFormDataParam[] | File;
cachePolicy?: CachePolicy;
content?: any;
cookiesEnabled?: boolean;
headers?: Headers;
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
onProgress?: (current: number, total: number) => void;
params?: HttpsRequestObject;
progressOnMainThread?: boolean;
responseOnMainThread?: boolean;
tag?: string;
timeout?: number;
url: string;
}
allowLargeResponse?: boolean;
body?: HttpsRequestObject | HttpsFormDataParam[] | File;
cachePolicy?: CachePolicy;
content?: any;
cookiesEnabled?: boolean;
headers?: Headers;
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS";
onProgress?: (current: number, total: number) => void;
params?: HttpsRequestObject;
progressOnMainThread?: boolean;
responseOnMainThread?: boolean;
tag?: string;
timeout?: number;
url: string;
}
Hierarchy
- HttpRequestOptions
- HttpsRequestOptions
Index
Properties
Properties
Optionalallow
allowLargeResponse?: boolean
On Android large responses may crash the app (fi. https://httpbin.org/bytes/10000). By setting this to true and when not using useLegacy, we allow large responses on the main thread (which this plugin currently does). Note that once set to true, this policy remains active until the app is killed.
-Optional body
-Optional cache
-Optional content
-content?: any
-content can be used to pass native custom okhttp3.RequestBody
-Optional cookies
-cookies
-default to true. Android and iOS only store cookies in memory! it will be cleared after an app restart
-Optional headers
-headers?: Headers
method
-method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD"
Optional on
-on
-
-
Type declaration
--
-
-
-
-
-
- (current: number, total: number): void -
-
--
iOS for now
---Parameters
--
-
-
-
current: number
- -
-
total: number
Returns void
-
-
Optional params
-params?: HttpsRequestObject
Optional tag
-tag?: string
Optional timeout
-timeout?: number
-Default 10 (seconds).
-url
-url: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Optionalbody
Optionalcache
Optionalcontent
content?: any
content can be used to pass native custom okhttp3.RequestBody
+Optionalcookies
cookiesEnabled?: boolean
default to true. Android and iOS only store cookies in memory! it will be cleared after an app restart
+Optionalheaders
Gets or sets the request headers in JSON format.
+method
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS"
Gets or sets the request method.
+Optionalon
onProgress?: (current: number, total: number) => void
iOS for now
+Optionalparams
Optionalprogress
progressOnMainThread?: boolean
Optionalresponse
responseOnMainThread?: boolean
default to true. Put to false to run response callback on current thread
+Optionaltag
tag?: string
Optionaltimeout
timeout?: number
Default 10 (seconds).
+url
url: string
Gets or sets the request url.
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-content
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface HttpsResponse<T>
Type Parameters
--
-
-
-
T = any
Hierarchy
--
-
- HttpsResponse
- Index
-
-
-
Properties
-Properties
-Optional content
-content?: T
content
-content
Optional description
-description?: string
Optional failure
-failure?: any
Optional headers
-headers?: Headers
Optional reason
-reason?: string
Optional status
-status
Optional url
-url?: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface HttpsResponse<T>
interface HttpsResponse<T = any> {
content?: T;
contentLength: number;
description?: string;
failure?: any;
headers?: Headers;
reason?: string;
response?: string;
statusCode?: number;
url?: string;
}
content?: T;
contentLength: number;
description?: string;
failure?: any;
headers?: Headers;
reason?: string;
response?: string;
statusCode?: number;
url?: string;
}
Type Parameters
- T = any
Index
Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-content
-
-
-
-to
-
-
-to
-
-
-to
-
-
-to
-
-
-
-
-
-
-to
-
-
-to
-
-
-
-
-Interface HttpsResponseLegacy<T>
Type Parameters
--
-
-
-
T = any
Hierarchy
--
-
- HttpsResponseLegacy
- Index
-
-
-
-
-
Properties
-Methods
-Properties
-content
-content
Methods
-to
-to
-to
-to
-toJSON
-toJSONAsync
-to
-to
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface HttpsResponseLegacy<T>
interface HttpsResponseLegacy<T = any> {
contentLength: number;
toArrayBuffer(): ArrayBuffer;
toArrayBufferAsync(): Promise<ArrayBuffer>;
toFile(destinationFilePath: string): Promise<File>;
toImage(): Promise<ImageSource>;
toJSON(): T;
toJSONAsync(): Promise<T>;
toString(): string;
toStringAsync(): Promise<string>;
}
contentLength: number;
toArrayBuffer(): ArrayBuffer;
toArrayBufferAsync(): Promise<ArrayBuffer>;
toFile(destinationFilePath: string): Promise<File>;
toImage(): Promise<ImageSource>;
toJSON(): T;
toJSONAsync(): Promise<T>;
toString(): string;
toStringAsync(): Promise<string>;
}
Type Parameters
- T = any
Index
Properties
Methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface HttpsSSLPinningOptions
Hierarchy
--
-
- HttpsSSLPinningOptions
- Index
-
-
-
Properties
-Properties
-Optional allow
-allow
certificate
-certificate: string
Optional common
-common
host
-host: string
Optional validates
-validates
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface HttpsSSLPinningOptions
interface HttpsSSLPinningOptions {
allowInvalidCertificates?: boolean;
certificate: string;
commonName?: string;
host: string;
validatesDomainName?: boolean;
}
allowInvalidCertificates?: boolean;
certificate: string;
commonName?: string;
host: string;
validatesDomainName?: boolean;
}
Index
Properties
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Nativescript plugin for https requests
Index
-Interfaces
-Type Aliases
-Variables
-Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Nativescript plugin for https requests
Interfaces
Type Aliases
Variables
-
-
-
-
-
-
-Type alias CachePolicy
Cache
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Alias CachePolicy
CachePolicy: "noCache" | "onlyCache" | "ignoreCache"
-
-
-
-
-
-Variable interceptors
-Variable interceptorsConst
interceptors: any[]
-
-
\ No newline at end of file
+Generated using TypeDoc
Variable interceptorsConst
interceptors: any[]
-
-
-
-
-
-Variable networkInterceptors
-Variable networkInterceptorsConst
network
-
-
\ No newline at end of file
+Generated using TypeDoc
Variable networkInterceptorsConst
networkInterceptors: any[]
Downloads the content from the specified URL as binary and returns an ArrayBuffer.
-