https/docs/index.html at angular · lekhmanrus/https

History

483 lines (444 loc) · 50.1 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

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

<!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 async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">

<div id="tsd-toolbar-links"><a href="https://docs.nativescript.org">Nativescript Doc</a></div></div>

<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>

<h2>Nativescript plugin for https requests</h2></div>

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

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

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

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

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

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

Nativescript plugin for https requests

<h2>Table of Contents</h2>

</a>

<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></pre>

<ul>

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

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

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

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

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

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

</ul>

</li>

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

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

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

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

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

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

</ul>

</li>

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

</ul>

</li>

</ul>

<h2>Installation</h2>

</a>

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>

<h4>A drop-in replacement for the <a href="https://docs.nativescript.org/cookbook/http">default http module</a>.</h4>

</a>

<h2>Features</h2>

</a>

<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>

</a>

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.

<h2>Installation</h2>

</a>

<pre><code class="language-bash">tns plugin add @nativescript-community/https

</code></pre>

<h2>Examples</h2>

</a>

<h3>Hitting an API using <code>GET</code> method</h3>

</a>

<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></pre>

<h2>Configuration</h2>

</a>

<h3>Installing your SSL certificate</h3>

</a>

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.

<h4>Enabling SSL pinning</h4>

</a>

<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></pre>

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

<h4>Disabling SSL pinning</h4>

</a>

</code></pre>

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

<h3>useLegacy</h3>

</a>

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>

<h3>Cookie</h3>

</a>

By default basic Cookie support is enabled to work like in {N} <code>http</code> module.

In the future more options will be added

<h3>Enabling Cache</h3>

</a>

<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></pre>

<h3>Multipart form data</h3>

</a>

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></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.

<h3>Options</h3>

</a>

<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></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>

<h2>Webpack / bundling</h2>

</a>

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>.

<h2><code>iOS</code> Troubleshooting</h2>

</a>

<h3>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!</h3>

</a>

</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></pre>

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

</blockquote>

<h2><code>Android</code> troubleshooting</h2>

</a>

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.

<h1>Thanks</h1>

</a>

<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>

<h3>Examples:</h3>

</a>

<ul>

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

<li>A basic example</li>

</ul>

</li>

</ul>

<h2>Demos and Development</h2>

</a>

<h3>Repo Setup</h3>

</a>

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></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.

<h3>Build</h3>

</a>

<pre><code class="language-bash">npm run build.all

</code></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>

<h3>Demos</h3>

</a>

<pre><code class="language-bash">npm run demo.[ng|react|svelte|vue].[ios|android] npm run demo.svelte.ios # Example

</code></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

<h2>Contributing</h2>

</a>

<h3>Update repo</h3>

</a>

You can update the repo files quite easily

First update the submodules

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

</code></pre>

Then commit the changes

Then update common files

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

</code></pre>

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

<h3>Update readme</h3>

</a>

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

</code></pre>

<h3>Update doc</h3>

</a>

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

</code></pre>

<h3>Publish</h3>

</a>

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></pre>

<h3>modifying submodules</h3>

</a>

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></pre>

<h2>Questions</h2>

</a>

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>

<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>

<h4 class="uppercase">Member Visibility</h4><form>

<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>

<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>

<ul>

<li class="current selected"><a href="modules.html">Nativescript plugin for https requests</a>

<ul>

<li class="tsd-kind-interface"><a href="interfaces/CacheOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>CacheOptions</a></li>

<li class="tsd-kind-interface"><a href="interfaces/Headers.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Headers</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsFormDataParam.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsFormDataParam</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsRequest</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsRequestObject.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsRequestObject</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsRequestOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsRequestOptions</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsResponse</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsResponseLegacy.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsResponseLegacy</a></li>

<li class="tsd-kind-interface"><a href="interfaces/HttpsSSLPinningOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>HttpsSSLPinningOptions</a></li>

<li class="tsd-kind-type-alias"><a href="types/CachePolicy.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>CachePolicy</a></li>

<li class="tsd-kind-variable"><a href="variables/interceptors.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>interceptors</a></li>

<li class="tsd-kind-variable"><a href="variables/networkInterceptors.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-32-path"></use><use href="#icon-32-text"></use></svg>networkInterceptors</a></li>

<li class="tsd-kind-function"><a href="functions/addInterceptor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>addInterceptor</a></li>

<li class="tsd-kind-function"><a href="functions/addNetworkInterceptor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>addNetworkInterceptor</a></li>

<li class="tsd-kind-function"><a href="functions/cancelAllRequests.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>cancelAllRequests</a></li>

<li class="tsd-kind-function"><a href="functions/cancelRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>cancelRequest</a></li>

<li class="tsd-kind-function"><a href="functions/clearCache.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>clearCache</a></li>

<li class="tsd-kind-function"><a href="functions/clearCookies.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>clearCookies</a></li>

<li class="tsd-kind-function"><a href="functions/createRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>createRequest</a></li>

<li class="tsd-kind-function"><a href="functions/disableSSLPinning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>disableSSLPinning</a></li>

<li class="tsd-kind-function"><a href="functions/enableSSLPinning.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>enableSSLPinning</a></li>

<li class="tsd-kind-function"><a href="functions/getBinary.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getBinary</a></li>

<li class="tsd-kind-function"><a href="functions/getClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getClient</a></li>

<li class="tsd-kind-function"><a href="functions/getFile.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getFile</a></li>

<li class="tsd-kind-function"><a href="functions/getFilenameFromUrl.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getFilenameFromUrl</a></li>

<li class="tsd-kind-function"><a href="functions/getImage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getImage</a></li>

<li class="tsd-kind-function"><a href="functions/getJSON.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getJSON</a></li>

<li class="tsd-kind-function"><a href="functions/getString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>getString</a></li>

<li class="tsd-kind-function"><a href="functions/parseJSON.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>parseJSON</a></li>

<li class="tsd-kind-function"><a href="functions/request.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>request</a></li>

<li class="tsd-kind-function"><a href="functions/setCache.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>setCache</a></li></ul></nav></div></div>

Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></div>

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