https/docs/index.html at master · CatchABus/https

History

319 lines (314 loc) · 49.7 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Nativescript plugin for https requests</title><meta name="description" content="Documentation for Nativescript plugin for https requests"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://docs.nativescript.org">Nativescript Doc</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Nativescript plugin for https requests</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Nativescript plugin for https requests</h2></div><div class="tsd-panel tsd-typography">

<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

DO NOT EDIT THIS READEME DIRECTLY! Edit "bluesprint.md" instead.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->

<h1 align="center">@nativescript-community/https</h1>

Nativescript plugin for https requests

<a id="md:table-of-contents" class="tsd-anchor"></a><h2><a href="#md:table-of-contents">Table of Contents</a></h2><pre><code>* [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)

</code><button>Copy</button></pre>

<ul>

<li><a href="#md:thanks">Thanks</a>

* <a href="#md:examples-1">Examples:</a><ul>

<li><a href="#md:demos-and-development">Demos and Development</a><ul>

<li><a href="#md:repo-setup">Repo Setup</a></li>

<li><a href="#md:build">Build</a></li>

<li><a href="#md:demos">Demos</a></li>

</ul>

</li>

<li><a href="#md:contributing">Contributing</a><ul>

<li><a href="#md:update-repo-">Update repo </a></li>

<li><a href="#md:update-readme-">Update readme </a></li>

<li><a href="#md:update-doc-">Update doc </a></li>

<li><a href="#md:publish">Publish</a></li>

<li><a href="#md:modifying-submodules">modifying submodules</a></li>

</ul>

</li>

<li><a href="#md:questions">Questions</a></li>

</ul>

</li>

</ul>

<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2>Run the following command from the root of your project:

<code>ns plugin add @nativescript-community/https</code>

Easily integrate the most reliable native networking libraries with the latest and greatest HTTPS security features.

Android: version 4.x using okhttp 4.x changing minSDKVersion to 21! If lower needed stick to 3.x

</blockquote>

Plugin version 2.0.0 bumps <code>AFNetworking</code> on iOS to <a href="https://github.com/AFNetworking/AFNetworking/releases/tag/4.0.0">4.0.0</a> which no longer relies on <code>UIWebView</code>. Make sure to run <code>pod repo update</code> to get the latest <code>AFNetworking</code> pod on your development machine.

</blockquote>

<a id="md:a-drop-in-replacement-for-the-default-http-module" class="tsd-anchor"></a><h4><a href="#md:a-drop-in-replacement-for-the-default-http-module">A drop-in replacement for the <a href="https://docs.nativescript.org/cookbook/http">default http module</a>.</a></h4><a href="#md:features"></a>

<a id="md:features" class="tsd-anchor"></a><h2><a href="#md:features">Features</a></h2><ul>

<li>Modern TLS & SSL security features</li>

<li>Shared connection pooling reduces request latency</li>

<li>Silently recovers from common connection problems</li>

<li>Everything runs on a native background thread</li>

<li>Transparent GZIP</li>

<li>HTTP/2 support</li>

<li>Multiform part</li>

<li>Cache</li>

<li>Basic Cookie support</li>

</ul>

What the flip is SSL pinning and all this security mumbo jumbo?

</blockquote>

<a href="https://infinum.co/the-capsized-eight/how-to-make-your-ios-apps-more-secure-with-ssl-pinning">How to make your apps more secure with SSL pinning</a>.

Do I have to use SSL pinning?

</blockquote>

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.

<a id="md:installation-1" class="tsd-anchor"></a><h2><a href="#md:installation-1">Installation</a></h2><pre><code class="language-bash">tns plugin add @nativescript-community/https

</code><button>Copy</button></pre>

<a id="md:examples" class="tsd-anchor"></a><h2><a href="#md:examples">Examples</a></h2><a id="md:hitting-an-api-using-get-method" class="tsd-anchor"></a><h3><a href="#md:hitting-an-api-using-get-method">Hitting an API using <code>GET</code> method</a></h3><pre><code class="language-typescript">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); });

</code><button>Copy</button></pre>

<a id="md:configuration" class="tsd-anchor"></a><h2><a href="#md:configuration">Configuration</a></h2><a id="md:installing-your-ssl-certificate" class="tsd-anchor"></a><h3><a href="#md:installing-your-ssl-certificate">Installing your SSL certificate</a></h3>Create a folder called <code>assets</code> in your projects <code>app</code> folder like so <code><project>/app/assets</code>. Using chrome, go to the URL where the SSL certificate resides. View the details then drag and drop the certificate image into the <code>assets</code> folder.

<a id="md:enabling-ssl-pinning" class="tsd-anchor"></a><h4><a href="#md:enabling-ssl-pinning">Enabling SSL pinning</a></h4><pre><code class="language-typescript">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 });

</code><button>Copy</button></pre>

Once you've enabled SSL pinning you CAN NOT re-enable with a different <code>host</code> or <code>certificate</code> file.

<a id="md:disabling-ssl-pinning" class="tsd-anchor"></a><h4><a href="#md:disabling-ssl-pinning">Disabling SSL pinning</a></h4><pre><code class="language-typescript">import * as Https from '@nativescript-community/https'; Https.disableSSLPinning();

</code><button>Copy</button></pre>

All requests after calling this method will no longer utilize SSL pinning until it is re-enabled once again.

<a id="md:uselegacy" class="tsd-anchor"></a><h3><a href="#md:uselegacy">useLegacy</a></h3>There is a new option called <code>useLegacy</code>. You can set of every request options.

When using that option the request will behave more like {N} http module.

<ul>

<li>the <code>content</code> returned by a request is not the resulting string but an object. It follows <a href="https://docs.nativescript.org/api-reference/interfaces/_http_.httpcontent">HTTPContent</a> format for the most part. You can call <code>toJSON</code> or <code>toFile</code>. The only difference is that <code>toFile</code> returns a <code>Promise<File></code> which means that it is async and run in a background thread!</li>

<li>an error return a <code>content</code> too allowing you to read its content.</li>

</ul>

<a id="md:cookie" class="tsd-anchor"></a><h3><a href="#md:cookie">Cookie</a></h3>By default basic Cookie support is enabled to work like in {N} <code>http</code> module.

In the future more options will be added

<a id="md:enabling-cache" class="tsd-anchor"></a><h3><a href="#md:enabling-cache">Enabling Cache</a></h3><pre><code class="language-typescript">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

</code><button>Copy</button></pre>

<a id="md:multipart-form-data" class="tsd-anchor"></a><h3><a href="#md:multipart-form-data">Multipart form data</a></h3>If you set the <code>Content-Type</code> header to <code>"multipart/form-data"</code> the request body will be evaluated as a multipart form data. Each body parameter is expected to be in this format:

<pre><code class="language-typescript">{ data: any parameterName: string, fileName?: string contentType?: string }

</code><button>Copy</button></pre>

if <code>fileName</code> and <code>contentType</code> are set then data is expected to be either a <code>NSData</code> on iOS or a <code>native.Array<number></code> on Android.

<a id="md:options" class="tsd-anchor"></a><h3><a href="#md:options">Options</a></h3><pre><code class="language-typescript">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; }

</code><button>Copy</button></pre>

<table>

<thead>

<tr>

<th>SSLPinning Option</th>

<th>Description</th>

</tr>

</thead>

<td><code>host: string</code></td>

<td>This must be the request domain name eg <code>sales.company.org</code>.</td>

</tr>

<tr>

<td><code>commonName?: string</code></td>

<td>Default: options.host, set if certificate CN is different from the host eg <code>*.company.org</code> (Android specific)</td>

</tr>

<tr>

<td><code>certificate: string</code></td>

<td>The uri path to your <code>.cer</code> certificate file.</td>

</tr>

<tr>

<td><code>allowInvalidCertificates?: boolean</code></td>

<td>Default: <code>false</code>. This should always be <code>false</code> if you are using SSL pinning. Set this to <code>true</code> if you're using a self-signed certificate.</td>

</tr>

<tr>

<td><code>validatesDomainName?: boolean</code></td>

<td>Default: <code>true</code>. Determines if the domain name should be validated with your pinned certificate.</td>

</tr>

</tbody></table>

<table>

<thead>

<tr>

<th>Requests Option</th>

<th>Description</th>

</tr>

</thead>

<td><code>useLegacy?: boolean</code></td>

<td>Default: <code>false</code>. [IOS only] set to true in order to get the response data (when status >= 300)in the <code>content</code> directly instead of <code>response.body.content</code>.</td>

</tr>

<tr>

<td>`cachePolicy?: 'noCache'</td>

<td>'onlyCache'</td>

</tr>

<tr>

<td><code>onProgress?: (current: number, total: number) => void</code></td>

<td>[IOS only] Set the progress callback.</td>

</tr>

</tbody></table>

<a id="md:webpack--bundling" class="tsd-anchor"></a><h2><a href="#md:webpack--bundling">Webpack / bundling</a></h2>Since you're probably shipping a certificate with your app (like <a href="https://github.com/nativescript-community/https/tree/master/demo/app/assets">our demo does</a>),

make sure it's bundled by Webpack as well. You can do this by <a href="https://github.com/nativescript-community/https/blob/a5c841c0af7ff6d9994fa23f7fba0df0514c58f1/demo/webpack.config.js#L240">adding the certificate(s) with the <code>CopyWebpackPlugin</code></a>.

<a id="md:ios-troubleshooting" class="tsd-anchor"></a><h2><a href="#md:ios-troubleshooting"><code>iOS</code> Troubleshooting</a></h2><blockquote>

<a id="md:please-educate-yourself-on-ios39s-app-transport-security-before-starting-beef" class="tsd-anchor"></a><h3><a href="#md:please-educate-yourself-on-ios39s-app-transport-security-before-starting-beef">Please educate yourself on iOS's <a href="https://github.com/codepath/ios_guides/wiki/App-Transport-Security">App Transport Security</a> before starting beef!</a></h3></blockquote>

If you try and hit an <code>https</code> 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 <code>Info.plist</code>:

<pre><code class="language-xml"><key>NSAppTransportSecurity</key> <dict> <key>NSAllowsArbitraryLoads</key> <true/> </dict>

</code><button>Copy</button></pre>

This plugin does not add <code>NSAllowsArbitraryLoads</code> to your projects <code>Info.plist</code> for you.

</blockquote>

<a id="md:android-troubleshooting" class="tsd-anchor"></a><h2><a href="#md:android-troubleshooting"><code>Android</code> troubleshooting</a></h2>If you app crashes with a message that it's doing too much networking on the main thread,

then pass the option <code>allowLargeResponse</code> with value <code>true</code> to the <code>request</code> function.

<a id="md:thanks" class="tsd-anchor"></a><h1><a href="#md:thanks">Thanks</a></h1><table>

<thead>

<tr>

</tr>

</thead>

<td><a href="https://github.com/roblav96">Robert Laverty</a></td>

<td>For creating and maintaining this plugin for a long time</td>

</tr>

<tr>

<td><a href="https://github.com/gethuman">Jeff Whelple</a></td>

<td>For contributing</td>

</tr>

<tr>

<td><a href="https://github.com/EddyVerbruggen">Eddy Verbruggen</a></td>

<td>For maintaining this before it got transferred</td>

</tr>

<tr>

<td><a href="https://github.com/AFNetworking">AFNetworking</a></td>

<td><a href="https://github.com/AFNetworking/AFNetworking">AFNetworking</a> A delightful networking framework for iOS, OS X, watchOS, and tvOS.</td>

</tr>

<tr>

<td><a href="http://square.github.io/">Square</a></td>

<td><a href="https://github.com/square/okhttp">okhttp</a> An HTTP+HTTP/2 client for Android and Java applications.</td>

</tr>

</tbody></table>

<a id="md:examples-1" class="tsd-anchor"></a><h3><a href="#md:examples-1">Examples:</a></h3><ul>

<li><a href="demo-snippets/vue/Basic.vue">Basic</a><ul>

<li>A basic example</li>

</ul>

</li>

</ul>

<a id="md:demos-and-development" class="tsd-anchor"></a><h2><a href="#md:demos-and-development">Demos and Development</a></h2><a id="md:repo-setup" class="tsd-anchor"></a><h3><a href="#md:repo-setup">Repo Setup</a></h3>The repo uses submodules. If you did not clone with <code> --recursive</code> then you need to call

<pre><code>git submodule update --init

</code><button>Copy</button></pre>

The package manager used to install and link dependencies must be <code>pnpm</code> or <code>yarn</code>. <code>npm</code> wont work.

To develop and test:

if you use <code>yarn</code> then run <code>yarn</code>

if you use <code>pnpm</code> then run <code>pnpm i</code>

Interactive Menu:

To start the interactive menu, run <code>npm start</code> (or <code>yarn start</code> or <code>pnpm start</code>). This will list all of the commonly used scripts.

<a id="md:build" class="tsd-anchor"></a><h3><a href="#md:build">Build</a></h3><pre><code class="language-bash">npm run build.all

</code><button>Copy</button></pre>

WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code>

<a id="md:demos" class="tsd-anchor"></a><h3><a href="#md:demos">Demos</a></h3><pre><code class="language-bash">npm run demo.[ng|react|svelte|vue].[ios|android] npm run demo.svelte.ios # Example

</code><button>Copy</button></pre>

Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>

Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>

You can start from the <code>install.ts</code> of each flavor to see how to register new demos

<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><a id="md:update-repo" class="tsd-anchor"></a><h3><a href="#md:update-repo">Update repo</a></h3>You can update the repo files quite easily

First update the submodules

<pre><code class="language-bash">npm run update

</code><button>Copy</button></pre>

Then commit the changes

Then update common files

<pre><code class="language-bash">npm run sync

</code><button>Copy</button></pre>

Then you can run <code>yarn|pnpm</code>, commit changed files if any

<a id="md:update-readme" class="tsd-anchor"></a><h3><a href="#md:update-readme">Update readme</a></h3><pre><code class="language-bash">npm run readme

</code><button>Copy</button></pre>

<a id="md:update-doc" class="tsd-anchor"></a><h3><a href="#md:update-doc">Update doc</a></h3><pre><code class="language-bash">npm run doc

</code><button>Copy</button></pre>

<a id="md:publish" class="tsd-anchor"></a><h3><a href="#md:publish">Publish</a></h3>The publishing is completely handled by <code>lerna</code> (you can add <code>-- --bump major</code> to force a major release)

Simply run

<pre><code class="language-shell">npm run publish

</code><button>Copy</button></pre>

<a id="md:modifying-submodules" class="tsd-anchor"></a><h3><a href="#md:modifying-submodules">modifying submodules</a></h3>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 <code>~/.gitconfig</code> and add

<pre><code>[url "ssh://[email protected]/"] pushInsteadOf = https://github.com/

</code><button>Copy</button></pre>

<a id="md:questions" class="tsd-anchor"></a><h2><a href="#md:questions">Questions</a></h2>If you have any questions/issues/comments please feel free to create an issue or start a conversation in the <a href="https://nativescript.org/discord">NativeScript Community Discord</a>.

<a id="md:demos-and-development-1" class="tsd-anchor"></a><h2><a href="#md:demos-and-development-1">Demos and Development</a></h2><a id="md:repo-setup-1" class="tsd-anchor"></a><h3><a href="#md:repo-setup-1">Repo Setup</a></h3>The repo uses submodules. If you did not clone with <code> --recursive</code> then you need to call

</code><button>Copy</button></pre>

The package manager used to install and link dependencies must be <code>pnpm</code> or <code>yarn</code>. <code>npm</code> wont work.

To develop and test:

if you use <code>yarn</code> then run <code>yarn</code>

if you use <code>pnpm</code> then run <code>pnpm i</code>

Interactive Menu:

To start the interactive menu, run <code>npm start</code> (or <code>yarn start</code> or <code>pnpm start</code>). This will list all of the commonly used scripts.

<a id="md:build-1" class="tsd-anchor"></a><h3><a href="#md:build-1">Build</a></h3><pre><code class="language-bash">npm run build.all

</code><button>Copy</button></pre>

WARNING: it seems <code>yarn build.all</code> wont always work (not finding binaries in <code>node_modules/.bin</code>) which is why the doc explicitly uses <code>npm run</code>

<a id="md:demos-1" class="tsd-anchor"></a><h3><a href="#md:demos-1">Demos</a></h3><pre><code class="language-bash">npm run demo.[ng|react|svelte|vue].[ios|android] npm run demo.svelte.ios # Example

</code><button>Copy</button></pre>

Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in <code>demo-[ng|react|svelte|vue]</code>

Instead you work in <code>demo-snippets/[ng|react|svelte|vue]</code>

You can start from the <code>install.ts</code> of each flavor to see how to register new demos

<a id="md:contributing-1" class="tsd-anchor"></a><h2><a href="#md:contributing-1">Contributing</a></h2><a id="md:update-repo-1" class="tsd-anchor"></a><h3><a href="#md:update-repo-1">Update repo</a></h3>You can update the repo files quite easily

First update the submodules

<pre><code class="language-bash">npm run update

</code><button>Copy</button></pre>

Then commit the changes

Then update common files

<pre><code class="language-bash">npm run sync

</code><button>Copy</button></pre>

Then you can run <code>yarn|pnpm</code>, commit changed files if any

<a id="md:update-readme-1" class="tsd-anchor"></a><h3><a href="#md:update-readme-1">Update readme</a></h3><pre><code class="language-bash">npm run readme

</code><button>Copy</button></pre>

<a id="md:update-doc-1" class="tsd-anchor"></a><h3><a href="#md:update-doc-1">Update doc</a></h3><pre><code class="language-bash">npm run doc

</code><button>Copy</button></pre>

<a id="md:publish-1" class="tsd-anchor"></a><h3><a href="#md:publish-1">Publish</a></h3>The publishing is completely handled by <code>lerna</code> (you can add <code>-- --bump major</code> to force a major release)

Simply run

<pre><code class="language-shell">npm run publish

</code><button>Copy</button></pre>

<a id="md:modifying-submodules-1" class="tsd-anchor"></a><h3><a href="#md:modifying-submodules-1">modifying submodules</a></h3>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 <code>~/.gitconfig</code> and add

</code><button>Copy</button></pre>

<a id="md:questions-1" class="tsd-anchor"></a><h2><a href="#md:questions-1">Questions</a></h2>If you have any questions/issues/comments please feel free to create an issue or start a conversation in the <a href="https://nativescript.org/discord">NativeScript Community Discord</a>.

</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Protected</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Private</label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg>Inherited</label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#md:table-of-contents">Table of Contents</a></li><li><a href="#md:installation">Installation</a></li><li><ul><li><ul><li><a href="#md:a-drop-in-replacement-for-the-default-http-module">A drop-in replacement for the default http module.</a></li></ul></li></ul></li><li><a href="#md:features">Features</a></li><li><a href="#md:faq">FAQ</a></li><li><a href="#md:installation-1">Installation</a></li><li><a href="#md:examples">Examples</a></li><li><ul><li><a href="#md:hitting-an-api-using-get-method">Hitting an API using GET method</a></li></ul></li><li><a href="#md:configuration">Configuration</a></li><li><ul><li><a href="#md:installing-your-ssl-certificate">Installing your SSL certificate</a></li><li><ul><li><a href="#md:enabling-ssl-pinning">Enabling SSL pinning</a></li><li><a href="#md:disabling-ssl-pinning">Disabling SSL pinning</a></li></ul></li><li><a href="#md:uselegacy">useLegacy</a></li><li><a href="#md:cookie">Cookie</a></li><li><a href="#md:enabling-cache">Enabling Cache</a></li><li><a href="#md:multipart-form-data">Multipart form data</a></li><li><a href="#md:options">Options</a></li></ul></li><li><a href="#md:webpack--bundling">Webpack / bundling</a></li><li><a href="#md:ios-troubleshooting">iOS Troubleshooting</a></li><li><ul><li><a href="#md:please-educate-yourself-on-ios39s-app-transport-security-before-starting-beef">Please educate yourself on iOS's App Transport Security before starting beef!</a></li></ul></li><li><a href="#md:android-troubleshooting">Android troubleshooting</a></li></ul><a href="#md:thanks">Thanks</a><ul><li><ul><li><a href="#md:examples-1">Examples:</a></li></ul></li><li><a href="#md:demos-and-development">Demos and Development</a></li><li><ul><li><a href="#md:repo-setup">Repo Setup</a></li><li><a href="#md:build">Build</a></li><li><a href="#md:demos">Demos</a></li></ul></li><li><a href="#md:contributing">Contributing</a></li><li><ul><li><a href="#md:update-repo">Update repo</a></li><li><a href="#md:update-readme">Update readme</a></li><li><a href="#md:update-doc">Update doc</a></li><li><a href="#md:publish">Publish</a></li><li><a href="#md:modifying-submodules">modifying submodules</a></li></ul></li><li><a href="#md:questions">Questions</a></li><li><a href="#md:demos-and-development-1">Demos and Development</a></li><li><ul><li><a href="#md:repo-setup-1">Repo Setup</a></li><li><a href="#md:build-1">Build</a></li><li><a href="#md:demos-1">Demos</a></li></ul></li><li><a href="#md:contributing-1">Contributing</a></li><li><ul><li><a href="#md:update-repo-1">Update repo</a></li><li><a href="#md:update-readme-1">Update readme</a></li><li><a href="#md:update-doc-1">Update doc</a></li><li><a href="#md:publish-1">Publish</a></li><li><a href="#md:modifying-submodules-1">modifying submodules</a></li></ul></li><li><a href="#md:questions-1">Questions</a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg>Nativescript plugin for https requests</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></footer><div class="overlay"></div></body></html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls