${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
+
diff --git a/docs/functions/cancelAllRequests.html b/docs/functions/cancelAllRequests.html
index 7543462..ac15ce3 100644
--- a/docs/functions/cancelAllRequests.html
+++ b/docs/functions/cancelAllRequests.html
@@ -1 +1 @@
-
Function createRequest
- create
Request(opts): HttpsRequest Parameters
- opts: HttpsRequestOptions
Returns HttpsRequest
Function createRequest
Parameters
- opts: HttpsRequestOptions
Returns HttpsRequest
Function enableSSLPinning
- enableSSLPinning(options): any
Parameters
- options: HttpsSSLPinningOptions
Returns any
Function enableSSLPinning
Parameters
- options: HttpsSSLPinningOptions
Returns any
Function getBinary
- get
Binary(arg): Promise<ArrayBuffer> Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
-
Returns Promise<ArrayBuffer>
- arg: string | HttpsRequestOptions
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): any Parameters
- opts: Partial<HttpsRequestOptions>
Returns any
Function getClient
Parameters
- opts: Partial<HttpsRequestOptions>
Returns any
Function getFile
- get
File(arg, destinationFilePath?): 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>
- arg: string | HttpsRequestOptions
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
diff --git a/docs/functions/getImage.html b/docs/functions/getImage.html
index c24fd05..f2e71a0 100644
--- a/docs/functions/getImage.html
+++ b/docs/functions/getImage.html
@@ -1,3 +1,3 @@
-
Function getImage
- get
Image(arg): 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>
- arg: string | HttpsRequestOptions
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): Promise<T>
Downloads the content from the specified URL as a string and returns its JSON.parse representation.
-Type Parameters
Parameters
- arg: string | HttpsRequestOptions
either The URL to request from or HttpsRequestOptions options.
-
Returns Promise<T>
- arg: string | HttpsRequestOptions
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): 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>
- arg: string | HttpsRequestOptions
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
Function request
- request<T, U>(options, useLegacy?): U extends true
? Promise<HttpsResponse<HttpsResponseLegacy<T>>>
: Promise<HttpsResponse<T>> Type Parameters
Parameters
- options: HttpsRequestOptions
OptionaluseLegacy: U
Returns U extends true
? Promise<HttpsResponse<HttpsResponseLegacy<T>>>
: Promise<HttpsResponse<T>>
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?): any Parameters
Optionaloptions: CacheOptions
Returns any
Function setCache
Parameters
Optionaloptions: CacheOptions
Returns any
Nativescript plugin for https requests
Hierarchy Summary
Nativescript plugin for https requests
+Nativescript plugin for https requests
- - - - - -
\ No newline at end of file
+
+
+
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
-
-
- Thanks
- * Examples:
-
-
-
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/httpsEasily integrate the most reliable native networking libraries with the latest and greatest HTTPS security features.
@@ -69,9 +85,9 @@
@nativescript-community/https
-Plugin version 2.0.0 bumps
AFNetworkingon iOS to 4.0.0 which no longer relies onUIWebView. Make sure to runpod repo updateto get the latestAFNetworkingpod on your development machine.A drop-in replacement for the default http module.
- -Features
-
+
- Modern TLS & SSL security features
- Shared connection pooling reduces request latency
- Silently recovers from common connection problems @@ -82,50 +98,57 @@
- Cache
- Basic Cookie support
- the
contentreturned by a request is not the resulting string but an object. It follows HTTPContent format for the most part. You can calltoJSONortoFile. The only difference is thattoFilereturns aPromise<File>which means that it is async and run in a background thread! - an error return a
contenttoo allowing you to read its content. - Basic
-
+
+
- Basic
+
- A basic example
A drop-in replacement for the default http module.
+ +Features
@nativescript-community/https
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.
- - -Installation
- - -tns plugin add @nativescript-community/https -Examples
Hitting an API using
GETmethod
- - -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
+assetsin your projectsappfolder 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 theassetsfolder.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 +Examples
Hitting an API using
GETmethod
+ + + +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
assetsin your projectsappfolder 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 theassetsfolder.
-
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
-hostorcertificatefile.Disabling SSL pinning
+import * as Https from '@nativescript-community/https';
Https.disableSSLPinning(); -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
+hostorcertificatefile.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.Cookie
By default basic Cookie support is enabled to work like in {N}
httpmodule. +Cookie
By default basic Cookie support is enabled to work like in {N}
-httpmodule. In the future more options will be addedEnabling 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-Typeheader 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
}
-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-Typeheader 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
-fileNameandcontentTypeare set then data is expected to be either aNSDataon iOS or anative.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;
} +
+ +@@ -133,7 +156,8 @@ -@nativescript-community/https
Description + +host: stringThis must be the request domain name eg sales.company.org.@nativescript-community/https
allowInvalidCertificates?: booleanDefault: +false. This should always befalseif you are using SSL pinning. Set this totrueif you're using a self-signed certificate.Default: false. This should always befalseif you are using SSL pinning. Set this totrueif you're using a self-signed certificate.validatesDomainName?: booleanDefault: true. Determines if the domain name should be validated with your pinned certificate.
- - -@@ -161,48 +186,56 @@ -@nativescript-community/https
Description + +useLegacy?: booleanDefault: false. [IOS only] set to true in order to get the response data (when status >= 300)in thecontentdirectly instead ofresponse.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.iOSTroubleshooting-
-Please educate yourself on iOS's App Transport Security before starting beef!
If you try and hit an
+ +httpsroute without adding it to App Transport Security's whitelist it will not work! + + +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.iOSTroubleshooting+
+Please educate yourself on iOS's App Transport Security before starting beef!
If you try and hit an
-httpsroute without adding it to App Transport Security's whitelist it will not work! You can bypass this behavior by adding the following to your projectsInfo.plist:
+<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict> -
+NSAppTransportSecurity ++ +NSAllowsArbitraryLoads ++
- - -This plugin does not add
NSAllowsArbitraryLoadsto your projectsInfo.plistfor you.AndroidtroubleshootingIf you app crashes with a message that it's doing too much networking on the main thread, +
+ +AndroidtroubleshootingIf you app crashes with a message that it's doing too much networking on the main thread, then pass the option
- - -allowLargeResponsewith valuetrueto therequestfunction.Thanks
+ + +
+Thanks
-Who Why + +Robert Laverty For creating and maintaining this plugin for a long time @nativescript-community/https
Square okhttp An HTTP+HTTP/2 client for Android and Java applications. -Examples:
-
-
Examples:
-
+
Demos and Development
Repo Setup
The repo uses submodules. If you did not clone with
---recursivethen you need to callgit submodule update --init + + +Demos and Development
Repo Setup
The repo uses submodules. If you did not clone with
+--recursivethen you need to call
+git submodule update --initThe package manager used to install and link dependencies must be
pnpmoryarn.npmwont work.To develop and test: if you use
yarnthen runyarnif you usepnpmthen runpnpm iInteractive Menu:
To start the interactive menu, run
-npm start(oryarn startorpnpm 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.allwont always work (not finding binaries innode_modules/.bin) which is why the doc explicitly usesnpm runDemos
+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 indemo-snippets/[ng|react|svelte|vue]-You can start from theinstall.tsof each flavor to see how to register new demosContributing
Update repo
You can update the repo files quite easily
+You can start from theinstall.tsof 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 -
+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 anyUpdate readme
-npm run readme -Update doc
-npm run doc -Publish
The publishing is completely handled by
-lerna(you can add-- --bump majorto 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. +
Update readme
+ +npm run readme +Update doc
+ +npm run doc +Publish
The publishing is completely handled by
+lerna(you can add-- --bump majorto 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
-~/.gitconfigand 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
---recursivethen you need to callgit 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.
+ +Demos and Development
Repo Setup
The repo uses submodules. If you did not clone with
+--recursivethen you need to call
+git submodule update --initThe package manager used to install and link dependencies must be
pnpmoryarn.npmwont work.To develop and test: if you use
yarnthen runyarnif you usepnpmthen runpnpm iInteractive Menu:
To start the interactive menu, run
-npm start(oryarn startorpnpm 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.allwont always work (not finding binaries innode_modules/.bin) which is why the doc explicitly usesnpm runDemos
+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 indemo-snippets/[ng|react|svelte|vue]-You can start from theinstall.tsof each flavor to see how to register new demosContributing
Update repo
You can update the repo files quite easily
+You can start from theinstall.tsof 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 -
+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 anyUpdate readme
-npm run readme -Update doc
-npm run doc -Publish
The publishing is completely handled by
-lerna(you can add-- --bump majorto 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. +
Update readme
+ +npm run readme +Update doc
+ +npm run doc +Publish
The publishing is completely handled by
+lerna(you can add-- --bump majorto 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
-~/.gitconfigand 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.
-
- Thanks
- * Examples:
-
-
-
- Demos and Development
Questions
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the NativeScript Community Discord.
+Interface CacheOptions
interface CacheOptions {
diskLocation: string;
diskSize: number;
forceCache?: boolean;
memorySize?: number;
}
diskLocation: string;
diskSize: number;
forceCache?: boolean;
memorySize?: number;
}
Index
Properties
Properties
disk
disk
disk
disk
Optional force
force
Optional memory
memory
Interface CacheOptions
interface CacheOptions {
diskLocation: string;
diskSize: number;
forceCache?: boolean;
memorySize?: number;
}
diskLocation: string;
diskSize: number;
forceCache?: boolean;
memorySize?: number;
}
Index
Properties
Interface Headers
interface Headers {
[k: string]: string;
}
[k: string]: string;
}
Indexable
[k: string]: string
Interface Headers
Indexable
- [k: string]: string
Interface HttpsFormDataParam
interface HttpsFormDataParam {
contentType?: string;
data: any;
fileName?: string;
parameterName: string;
}
contentType?: string;
data: any;
fileName?: string;
parameterName: string;
}
Index
Properties
Properties
Optional content
content
data
data: any
Optional file
file
parameter
parameter
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
+
Interface HttpsRequest
Index
Properties
Methods
Interface HttpsRequestObject
interface HttpsRequestObject {
[key: string]: string | number | boolean | HttpsRequestObject | any[] | HttpsFormDataParam;
}
[key: string]: string | number | boolean | HttpsRequestObject | any[] | HttpsFormDataParam;
}
Indexable
Interface HttpsRequestObject
Indexable
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";
onProgress?: ((current, total) => void);
params?: HttpsRequestObject;
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";
onProgress?: ((current, total) => void);
params?: HttpsRequestObject;
responseOnMainThread?: boolean;
tag?: string;
timeout?: number;
url: string;
}
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
method
method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD"
Optional on
on
iOS for now
-Type declaration
- (current, total): void
Parameters
- current: number
- total: number
Returns void
Optional params
Optional response
response
default to true. Put to false to run response callback on current thread
-Optional tag
tag?: string
Optional timeout
timeout?: number
Default 10 (seconds).
-url
url: string
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.
+Interface HttpsResponse<T>
interface HttpsResponse<T> {
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
Index
Properties
Properties
Optional content
content
content
Optional description
description?: string
Optional failure
failure?: any
Optional headers
Optional reason
reason?: string
Optional response
response?: string
Optional status
status
Optional url
url?: string
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
Interface HttpsResponseLegacy<T>
interface HttpsResponseLegacy<T> {
contentLength: number;
toArrayBuffer(): ArrayBuffer;
toArrayBufferAsync(): Promise<ArrayBuffer>;
toFile(destinationFilePath): Promise<File>;
toImage(): Promise<ImageSource>;
toJSON(): T;
toJSONAsync(): Promise<T>;
toString(): string;
toStringAsync(): Promise<string>;
}
contentLength: number;
toArrayBuffer(): ArrayBuffer;
toArrayBufferAsync(): Promise<ArrayBuffer>;
toFile(destinationFilePath): Promise<File>;
toImage(): Promise<ImageSource>;
toJSON(): T;
toJSONAsync(): Promise<T>;
toString(): string;
toStringAsync(): Promise<string>;
}
Type Parameters
Index
Properties
Methods
Properties
content
content
Methods
to
to
to
to
toJSON
toJSONAsync
to
to
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
interface HttpsSSLPinningOptions {
allowInvalidCertificates?: boolean;
certificate: string;
commonName?: string;
host: string;
validatesDomainName?: boolean;
}
allowInvalidCertificates?: boolean;
certificate: string;
commonName?: string;
host: string;
validatesDomainName?: boolean;
}
Index
Properties
Properties
Optional allow
allow
certificate
certificate: string
Optional common
common
host
host: string
Optional validates
validates
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
Nativescript plugin for https requests
Interfaces
Type Aliases
Variables
Type alias CachePolicy
Cache
Type Alias CachePolicy
CachePolicy: "noCache" | "onlyCache" | "ignoreCache"
Variable interceptorsConst
interceptors: any[]
Variable interceptorsConst
interceptors: any[]
Variable networkInterceptorsConst
network
Variable networkInterceptorsConst
networkInterceptors: any[]
Downloads the content from the specified URL as binary and returns an ArrayBuffer.
-