UNPKG

21.4 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Module: httpUtil</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Module: httpUtil</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31
32
33</header>
34
35<article>
36 <div class="container-overview">
37
38
39
40
41
42 </div>
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59 <h3 class="subsection-title">Methods</h3>
60
61
62
63
64
65
66
67 <h4 class="name" id=".delete"><span class="type-signature">(static) </span>delete<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
68
69
70
71
72
73
74<div class="description">
75 <p>Deletes data from a URL.</p>
76</div>
77
78
79
80
81
82
83
84
85
86 <h5>Parameters:</h5>
87
88
89<table class="params">
90 <thead>
91 <tr>
92
93 <th>Name</th>
94
95
96 <th>Type</th>
97
98
99 <th>Attributes</th>
100
101
102
103
104 <th class="last">Description</th>
105 </tr>
106 </thead>
107
108 <tbody>
109
110
111 <tr>
112
113 <td class="name"><code>url</code></td>
114
115
116 <td class="type">
117
118
119<span class="param-type">String</span>
120
121
122
123 </td>
124
125
126 <td class="attributes">
127
128
129
130
131
132 </td>
133
134
135
136
137 <td class="description last"><p>URL from which to get the data.</p></td>
138 </tr>
139
140
141
142 <tr>
143
144 <td class="name"><code>options</code></td>
145
146
147 <td class="type">
148
149
150<span class="param-type">Object</span>
151
152
153
154 </td>
155
156
157 <td class="attributes">
158
159 &lt;optional><br>
160
161
162
163
164
165 </td>
166
167
168
169
170 <td class="description last"><p>Optional parameters</p>
171 <h6>Properties</h6>
172
173
174<table class="params">
175 <thead>
176 <tr>
177
178 <th>Name</th>
179
180
181 <th>Type</th>
182
183
184 <th>Attributes</th>
185
186
187
188
189 <th class="last">Description</th>
190 </tr>
191 </thead>
192
193 <tbody>
194
195
196 <tr>
197
198 <td class="name"><code>headers</code></td>
199
200
201 <td class="type">
202
203
204<span class="param-type">Object</span>
205
206
207
208 </td>
209
210
211 <td class="attributes">
212
213 &lt;optional><br>
214
215
216
217
218
219 </td>
220
221
222
223
224 <td class="description last"><p>Map of headers to add to the request. Format:</p>
225<pre class="prettyprint source"><code> {
226 &lt;header1_name>: &lt;header1_value>,
227 &lt;header2_name>: &lt;header2_value>
228 }</code></pre></td>
229 </tr>
230
231
232
233 <tr>
234
235 <td class="name"><code>body</code></td>
236
237
238 <td class="type">
239
240
241<span class="param-type">Object</span>
242
243
244
245 </td>
246
247
248 <td class="attributes">
249
250 &lt;optional><br>
251
252
253
254
255
256 </td>
257
258
259
260
261 <td class="description last"><p>Body to send with request</p></td>
262 </tr>
263
264
265 </tbody>
266</table>
267
268 </td>
269 </tr>
270
271
272 </tbody>
273</table>
274
275
276
277
278
279
280<dl class="details">
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</dl>
314
315
316
317
318
319
320
321
322
323
324
325
326
327<h5>Returns:</h5>
328
329
330<div class="param-desc">
331 <p>A promise which will be resolved with the data
332 or rejected if an error occurs.</p>
333</div>
334
335
336
337<dl>
338 <dt>
339 Type
340 </dt>
341 <dd>
342
343<span class="param-type">String</span>
344
345
346 </dd>
347</dl>
348
349
350
351
352
353
354
355
356
357
358
359
360
361 <h4 class="name" id=".get"><span class="type-signature">(static) </span>get<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
362
363
364
365
366
367
368<div class="description">
369 <p>Gets data from a URL.</p>
370</div>
371
372
373
374
375
376
377
378
379
380 <h5>Parameters:</h5>
381
382
383<table class="params">
384 <thead>
385 <tr>
386
387 <th>Name</th>
388
389
390 <th>Type</th>
391
392
393 <th>Attributes</th>
394
395
396
397
398 <th class="last">Description</th>
399 </tr>
400 </thead>
401
402 <tbody>
403
404
405 <tr>
406
407 <td class="name"><code>url</code></td>
408
409
410 <td class="type">
411
412
413<span class="param-type">String</span>
414
415
416
417 </td>
418
419
420 <td class="attributes">
421
422
423
424
425
426 </td>
427
428
429
430
431 <td class="description last"><p>URL from which to get the data.</p></td>
432 </tr>
433
434
435
436 <tr>
437
438 <td class="name"><code>options</code></td>
439
440
441 <td class="type">
442
443
444<span class="param-type">Object</span>
445
446
447
448 </td>
449
450
451 <td class="attributes">
452
453 &lt;optional><br>
454
455
456
457
458
459 </td>
460
461
462
463
464 <td class="description last"><p>Optional parameters</p>
465 <h6>Properties</h6>
466
467
468<table class="params">
469 <thead>
470 <tr>
471
472 <th>Name</th>
473
474
475 <th>Type</th>
476
477
478 <th>Attributes</th>
479
480
481
482
483 <th class="last">Description</th>
484 </tr>
485 </thead>
486
487 <tbody>
488
489
490 <tr>
491
492 <td class="name"><code>headers</code></td>
493
494
495 <td class="type">
496
497
498<span class="param-type">Object</span>
499
500
501
502 </td>
503
504
505 <td class="attributes">
506
507 &lt;optional><br>
508
509
510
511
512
513 </td>
514
515
516
517
518 <td class="description last"><p>Map of headers to add to the request. Format:</p>
519<pre class="prettyprint source"><code> {
520 &lt;header1_name>: &lt;header1_value>,
521 &lt;header2_name>: &lt;header2_value>
522 }</code></pre></td>
523 </tr>
524
525
526 </tbody>
527</table>
528
529 </td>
530 </tr>
531
532
533 </tbody>
534</table>
535
536
537
538
539
540
541<dl class="details">
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574</dl>
575
576
577
578
579
580
581
582
583
584
585
586
587
588<h5>Returns:</h5>
589
590
591<div class="param-desc">
592 <p>A promise which will be resolved with the data
593 or rejected if an error occurs.</p>
594</div>
595
596
597
598<dl>
599 <dt>
600 Type
601 </dt>
602 <dd>
603
604<span class="param-type">String</span>
605
606
607 </dd>
608</dl>
609
610
611
612
613
614
615
616
617
618
619
620
621
622 <h4 class="name" id=".patch"><span class="type-signature">(static) </span>patch<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
623
624
625
626
627
628
629<div class="description">
630 <p>Patches data to a URL.</p>
631</div>
632
633
634
635
636
637
638
639
640
641 <h5>Parameters:</h5>
642
643
644<table class="params">
645 <thead>
646 <tr>
647
648 <th>Name</th>
649
650
651 <th>Type</th>
652
653
654 <th>Attributes</th>
655
656
657
658
659 <th class="last">Description</th>
660 </tr>
661 </thead>
662
663 <tbody>
664
665
666 <tr>
667
668 <td class="name"><code>url</code></td>
669
670
671 <td class="type">
672
673
674<span class="param-type">String</span>
675
676
677
678 </td>
679
680
681 <td class="attributes">
682
683
684
685
686
687 </td>
688
689
690
691
692 <td class="description last"><p>URL from which to get the data.</p></td>
693 </tr>
694
695
696
697 <tr>
698
699 <td class="name"><code>options</code></td>
700
701
702 <td class="type">
703
704
705<span class="param-type">Object</span>
706
707
708
709 </td>
710
711
712 <td class="attributes">
713
714 &lt;optional><br>
715
716
717
718
719
720 </td>
721
722
723
724
725 <td class="description last"><p>Optional parameters</p>
726 <h6>Properties</h6>
727
728
729<table class="params">
730 <thead>
731 <tr>
732
733 <th>Name</th>
734
735
736 <th>Type</th>
737
738
739 <th>Attributes</th>
740
741
742
743
744 <th class="last">Description</th>
745 </tr>
746 </thead>
747
748 <tbody>
749
750
751 <tr>
752
753 <td class="name"><code>headers</code></td>
754
755
756 <td class="type">
757
758
759<span class="param-type">Object</span>
760
761
762
763 </td>
764
765
766 <td class="attributes">
767
768 &lt;optional><br>
769
770
771
772
773
774 </td>
775
776
777
778
779 <td class="description last"><p>Map of headers to add to the request. Format:</p>
780<pre class="prettyprint source"><code> {
781 &lt;header1_name>: &lt;header1_value>,
782 &lt;header2_name>: &lt;header2_value>
783 }</code></pre></td>
784 </tr>
785
786
787
788 <tr>
789
790 <td class="name"><code>body</code></td>
791
792
793 <td class="type">
794
795
796<span class="param-type">Object</span>
797
798
799
800 </td>
801
802
803 <td class="attributes">
804
805 &lt;optional><br>
806
807
808
809
810
811 </td>
812
813
814
815
816 <td class="description last"><p>Body to send with request</p></td>
817 </tr>
818
819
820 </tbody>
821</table>
822
823 </td>
824 </tr>
825
826
827 </tbody>
828</table>
829
830
831
832
833
834
835<dl class="details">
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868</dl>
869
870
871
872
873
874
875
876
877
878
879
880
881
882<h5>Returns:</h5>
883
884
885<div class="param-desc">
886 <p>A promise which will be resolved with the data
887 or rejected if an error occurs.</p>
888</div>
889
890
891
892<dl>
893 <dt>
894 Type
895 </dt>
896 <dd>
897
898<span class="param-type">String</span>
899
900
901 </dd>
902</dl>
903
904
905
906
907
908
909
910
911
912
913
914
915
916 <h4 class="name" id=".post"><span class="type-signature">(static) </span>post<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
917
918
919
920
921
922
923<div class="description">
924 <p>Posts data to a URL.</p>
925</div>
926
927
928
929
930
931
932
933
934
935 <h5>Parameters:</h5>
936
937
938<table class="params">
939 <thead>
940 <tr>
941
942 <th>Name</th>
943
944
945 <th>Type</th>
946
947
948 <th>Attributes</th>
949
950
951
952
953 <th class="last">Description</th>
954 </tr>
955 </thead>
956
957 <tbody>
958
959
960 <tr>
961
962 <td class="name"><code>url</code></td>
963
964
965 <td class="type">
966
967
968<span class="param-type">String</span>
969
970
971
972 </td>
973
974
975 <td class="attributes">
976
977
978
979
980
981 </td>
982
983
984
985
986 <td class="description last"><p>URL from which to get the data.</p></td>
987 </tr>
988
989
990
991 <tr>
992
993 <td class="name"><code>options</code></td>
994
995
996 <td class="type">
997
998
999<span class="param-type">Object</span>
1000
1001
1002
1003 </td>
1004
1005
1006 <td class="attributes">
1007
1008 &lt;optional><br>
1009
1010
1011
1012
1013
1014 </td>
1015
1016
1017
1018
1019 <td class="description last"><p>Optional parameters</p>
1020 <h6>Properties</h6>
1021
1022
1023<table class="params">
1024 <thead>
1025 <tr>
1026
1027 <th>Name</th>
1028
1029
1030 <th>Type</th>
1031
1032
1033 <th>Attributes</th>
1034
1035
1036
1037
1038 <th class="last">Description</th>
1039 </tr>
1040 </thead>
1041
1042 <tbody>
1043
1044
1045 <tr>
1046
1047 <td class="name"><code>headers</code></td>
1048
1049
1050 <td class="type">
1051
1052
1053<span class="param-type">Object</span>
1054
1055
1056
1057 </td>
1058
1059
1060 <td class="attributes">
1061
1062 &lt;optional><br>
1063
1064
1065
1066
1067
1068 </td>
1069
1070
1071
1072
1073 <td class="description last"><p>Map of headers to add to the request. Format:</p>
1074<pre class="prettyprint source"><code> {
1075 &lt;header1_name>: &lt;header1_value>,
1076 &lt;header2_name>: &lt;header2_value>
1077 }</code></pre></td>
1078 </tr>
1079
1080
1081
1082 <tr>
1083
1084 <td class="name"><code>body</code></td>
1085
1086
1087 <td class="type">
1088
1089
1090<span class="param-type">Object</span>
1091
1092
1093
1094 </td>
1095
1096
1097 <td class="attributes">
1098
1099 &lt;optional><br>
1100
1101
1102
1103
1104
1105 </td>
1106
1107
1108
1109
1110 <td class="description last"><p>Body to send with request</p></td>
1111 </tr>
1112
1113
1114 </tbody>
1115</table>
1116
1117 </td>
1118 </tr>
1119
1120
1121 </tbody>
1122</table>
1123
1124
1125
1126
1127
1128
1129<dl class="details">
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162</dl>
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176<h5>Returns:</h5>
1177
1178
1179<div class="param-desc">
1180 <p>A promise which will be resolved with the data
1181 or rejected if an error occurs.</p>
1182</div>
1183
1184
1185
1186<dl>
1187 <dt>
1188 Type
1189 </dt>
1190 <dd>
1191
1192<span class="param-type">String</span>
1193
1194
1195 </dd>
1196</dl>
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210 <h4 class="name" id=".put"><span class="type-signature">(static) </span>put<span class="signature">(url, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
1211
1212
1213
1214
1215
1216
1217<div class="description">
1218 <p>Puts data to a URL.</p>
1219</div>
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229 <h5>Parameters:</h5>
1230
1231
1232<table class="params">
1233 <thead>
1234 <tr>
1235
1236 <th>Name</th>
1237
1238
1239 <th>Type</th>
1240
1241
1242 <th>Attributes</th>
1243
1244
1245
1246
1247 <th class="last">Description</th>
1248 </tr>
1249 </thead>
1250
1251 <tbody>
1252
1253
1254 <tr>
1255
1256 <td class="name"><code>url</code></td>
1257
1258
1259 <td class="type">
1260
1261
1262<span class="param-type">String</span>
1263
1264
1265
1266 </td>
1267
1268
1269 <td class="attributes">
1270
1271
1272
1273
1274
1275 </td>
1276
1277
1278
1279
1280 <td class="description last"><p>URL from which to get the data.</p></td>
1281 </tr>
1282
1283
1284
1285 <tr>
1286
1287 <td class="name"><code>options</code></td>
1288
1289
1290 <td class="type">
1291
1292
1293<span class="param-type">Object</span>
1294
1295
1296
1297 </td>
1298
1299
1300 <td class="attributes">
1301
1302 &lt;optional><br>
1303
1304
1305
1306
1307
1308 </td>
1309
1310
1311
1312
1313 <td class="description last"><p>Optional parameters</p>
1314 <h6>Properties</h6>
1315
1316
1317<table class="params">
1318 <thead>
1319 <tr>
1320
1321 <th>Name</th>
1322
1323
1324 <th>Type</th>
1325
1326
1327 <th>Attributes</th>
1328
1329
1330
1331
1332 <th class="last">Description</th>
1333 </tr>
1334 </thead>
1335
1336 <tbody>
1337
1338
1339 <tr>
1340
1341 <td class="name"><code>headers</code></td>
1342
1343
1344 <td class="type">
1345
1346
1347<span class="param-type">Object</span>
1348
1349
1350
1351 </td>
1352
1353
1354 <td class="attributes">
1355
1356 &lt;optional><br>
1357
1358
1359
1360
1361
1362 </td>
1363
1364
1365
1366
1367 <td class="description last"><p>Map of headers to add to the request. Format:</p>
1368<pre class="prettyprint source"><code> {
1369 &lt;header1_name>: &lt;header1_value>,
1370 &lt;header2_name>: &lt;header2_value>
1371 }</code></pre></td>
1372 </tr>
1373
1374
1375
1376 <tr>
1377
1378 <td class="name"><code>body</code></td>
1379
1380
1381 <td class="type">
1382
1383
1384<span class="param-type">Object</span>
1385
1386
1387
1388 </td>
1389
1390
1391 <td class="attributes">
1392
1393 &lt;optional><br>
1394
1395
1396
1397
1398
1399 </td>
1400
1401
1402
1403
1404 <td class="description last"><p>Body to send with request</p></td>
1405 </tr>
1406
1407
1408 </tbody>
1409</table>
1410
1411 </td>
1412 </tr>
1413
1414
1415 </tbody>
1416</table>
1417
1418
1419
1420
1421
1422
1423<dl class="details">
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456</dl>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470<h5>Returns:</h5>
1471
1472
1473<div class="param-desc">
1474 <p>A promise which will be resolved with the data
1475 or rejected if an error occurs.</p>
1476</div>
1477
1478
1479
1480<dl>
1481 <dt>
1482 Type
1483 </dt>
1484 <dd>
1485
1486<span class="param-type">String</span>
1487
1488
1489 </dd>
1490</dl>
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504</article>
1505
1506</section>
1507
1508
1509
1510
1511</div>
1512
1513<nav>
1514 <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-authn.html">authn</a></li><li><a href="module-bigIqLicenseProviderFactory.html">bigIqLicenseProviderFactory</a></li><li><a href="module-cryptoUtil.html">cryptoUtil</a></li><li><a href="module-httpUtil.html">httpUtil</a></li><li><a href="module-ipc.html">ipc</a></li><li><a href="module-localCryptoUtil.html">localCryptoUtil</a></li><li><a href="module-localKeyUtil.html">localKeyUtil</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-metricsCollector.html">metricsCollector</a></li><li><a href="module-sharedConstants.html">sharedConstants</a></li><li><a href="module-signals.html">signals</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="BigIp.html">BigIp</a></li><li><a href="BigIpCluster.html">BigIpCluster</a></li><li><a href="BigIpGtm.html">BigIpGtm</a></li><li><a href="BigIpOnboard.html">BigIpOnboard</a></li><li><a href="BigIq.html">BigIq</a></li><li><a href="BigIq50LicenseProvider.html">BigIq50LicenseProvider</a></li><li><a href="BigIq52LicenseProvider.html">BigIq52LicenseProvider</a></li><li><a href="BigIq53LicenseProvider.html">BigIq53LicenseProvider</a></li><li><a href="BigIq54LicenseProvider.html">BigIq54LicenseProvider</a></li><li><a href="CloudProvider.html">CloudProvider</a></li><li><a href="DnsProvider.html">DnsProvider</a></li><li><a href="GenericNodeProvider.html">GenericNodeProvider</a></li><li><a href="GtmDnsProvider.html">GtmDnsProvider</a></li><li><a href="IControl.html">IControl</a></li></ul><h3>Mixins</h3><ul><li><a href="bigIqClusterMixins.html">bigIqClusterMixins</a></li><li><a href="bigIqOnboardMixins.html">bigIqOnboardMixins</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkTask">checkTask</a></li><li><a href="global.html#forceResetUserPassword">forceResetUserPassword</a></li><li><a href="global.html#getDataFromPropPath">getDataFromPropPath</a></li><li><a href="global.html#getLicenseProvider">getLicenseProvider</a></li></ul>
1515</nav>
1516
1517<br class="clear">
1518
1519<footer>
1520 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
1521</footer>
1522
1523<script> prettyPrint(); </script>
1524<script src="scripts/linenumber.js"> </script>
1525</body>
1526</html>
\No newline at end of file