@beauraines/rtm-api 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +285 -0
  3. package/config.js +22 -0
  4. package/docs/RTMClient.html +2798 -0
  5. package/docs/RTMError.html +1029 -0
  6. package/docs/RTMList.html +966 -0
  7. package/docs/RTMResponse.html +868 -0
  8. package/docs/RTMSuccess.html +337 -0
  9. package/docs/RTMTask.html +2461 -0
  10. package/docs/RTMUser.html +6761 -0
  11. package/docs/client_auth.js.html +123 -0
  12. package/docs/client_index.js.html +241 -0
  13. package/docs/client_user.js.html +170 -0
  14. package/docs/global.html +386 -0
  15. package/docs/index.html +305 -0
  16. package/docs/list_index.js.html +159 -0
  17. package/docs/response_error.js.html +172 -0
  18. package/docs/response_response.js.html +160 -0
  19. package/docs/response_success.js.html +104 -0
  20. package/docs/scripts/linenumber.js +25 -0
  21. package/docs/scripts/prettify/Apache-License-2.0.txt +202 -0
  22. package/docs/scripts/prettify/lang-css.js +2 -0
  23. package/docs/scripts/prettify/prettify.js +28 -0
  24. package/docs/styles/jsdoc.css +664 -0
  25. package/docs/styles/prettify.css +79 -0
  26. package/docs/task_helper.js.html +531 -0
  27. package/docs/task_index.js.html +304 -0
  28. package/docs/user_index.js.html +347 -0
  29. package/docs/user_lists.js.html +208 -0
  30. package/docs/user_tasks.js.html +703 -0
  31. package/jsdoc.json +13 -0
  32. package/package.json +33 -0
  33. package/src/client/auth.js +65 -0
  34. package/src/client/index.js +182 -0
  35. package/src/client/user.js +112 -0
  36. package/src/list/helper.js +131 -0
  37. package/src/list/index.js +101 -0
  38. package/src/response/error.js +114 -0
  39. package/src/response/index.js +8 -0
  40. package/src/response/parse.js +51 -0
  41. package/src/response/response.js +102 -0
  42. package/src/response/success.js +46 -0
  43. package/src/task/helper.js +469 -0
  44. package/src/task/index.js +264 -0
  45. package/src/user/index.js +288 -0
  46. package/src/user/lists.js +150 -0
  47. package/src/user/tasks.js +708 -0
  48. package/src/utils/auth.js +188 -0
  49. package/src/utils/fetch.js +67 -0
  50. package/src/utils/get.js +247 -0
  51. package/src/utils/sign.js +93 -0
  52. package/src/utils/taskIds.js +188 -0
package/docs/RTMError.html ADDED
@@ -0,0 +1,1029 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <title>RTMError - Documentation</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.css">
13
+ <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
14
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
15
+ </head>
16
+ <body>
17
+
18
+ <input type="checkbox" id="nav-trigger" class="nav-trigger" />
19
+ <label for="nav-trigger" class="navicon-button x">
20
+ <div class="navicon"></div>
21
+ </label>
22
+
23
+ <label for="nav-trigger" class="overlay"></label>
24
+
25
+ <nav>
26
+ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="RTMClient.html">RTMClient</a><ul class='methods'><li data-type='method'><a href="RTMClient.html#get">get</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthToken">auth/getAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~auth/getAuthUrl">auth/getAuthUrl</a></li><li data-type='method'><a href="RTMClient.html#~auth/verifyAuthToken">auth/verifyAuthToken</a></li><li data-type='method'><a href="RTMClient.html#~user/create">user/create</a></li><li data-type='method'><a href="RTMClient.html#~user/export">user/export</a></li><li data-type='method'><a href="RTMClient.html#~user/exportToString">user/exportToString</a></li><li data-type='method'><a href="RTMClient.html#~user/import">user/import</a></li><li data-type='method'><a href="RTMClient.html#~user/importFromString">user/importFromString</a></li></ul></li><li><a href="RTMError.html">RTMError</a><ul class='methods'><li data-type='method'><a href="RTMError.html#.networkError">networkError</a></li><li data-type='method'><a href="RTMError.html#.rateLimitError">rateLimitError</a></li><li data-type='method'><a href="RTMError.html#.referenceError">referenceError</a></li><li data-type='method'><a href="RTMError.html#.responseError">responseError</a></li><li data-type='method'><a href="RTMError.html#.serverError">serverError</a></li><li data-type='method'><a href="RTMError.html#toString">toString</a></li></ul></li><li><a href="RTMList.html">RTMList</a></li><li><a href="RTMResponse.html">RTMResponse</a><ul class='methods'><li data-type='method'><a href="RTMResponse.html#has">has</a></li><li data-type='method'><a href="RTMResponse.html#toString">toString</a></li></ul></li><li><a href="RTMSuccess.html">RTMSuccess</a><ul class='methods'><li data-type='method'><a href="RTMSuccess.html#toString">toString</a></li></ul></li><li><a href="RTMTask.html">RTMTask</a></li><li><a href="RTMUser.html">RTMUser</a><ul class='methods'><li data-type='method'><a href="RTMUser.html#clearTaskIndexCache">clearTaskIndexCache</a></li><li data-type='method'><a href="RTMUser.html#get">get</a></li><li data-type='method'><a href="RTMUser.html#verifyAuthToken">verifyAuthToken</a></li><li data-type='method'><a href="RTMUser.html#~lists/add">lists/add</a></li><li data-type='method'><a href="RTMUser.html#~lists/archive">lists/archive</a></li><li data-type='method'><a href="RTMUser.html#~lists/get">lists/get</a></li><li data-type='method'><a href="RTMUser.html#~lists/remove">lists/remove</a></li><li data-type='method'><a href="RTMUser.html#~lists/rename">lists/rename</a></li><li data-type='method'><a href="RTMUser.html#~tasks/add">tasks/add</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addNotes">tasks/addNotes</a></li><li data-type='method'><a href="RTMUser.html#~tasks/addTags">tasks/addTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/complete">tasks/complete</a></li><li data-type='method'><a href="RTMUser.html#~tasks/decreasePriority">tasks/decreasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/get">tasks/get</a></li><li data-type='method'><a href="RTMUser.html#~tasks/getTask">tasks/getTask</a></li><li data-type='method'><a href="RTMUser.html#~tasks/increasePriority">tasks/increasePriority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/move">tasks/move</a></li><li data-type='method'><a href="RTMUser.html#~tasks/postpone">tasks/postpone</a></li><li data-type='method'><a href="RTMUser.html#~tasks/priority">tasks/priority</a></li><li data-type='method'><a href="RTMUser.html#~tasks/remove">tasks/remove</a></li><li data-type='method'><a href="RTMUser.html#~tasks/removeTags">tasks/removeTags</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setDueDate">tasks/setDueDate</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setName">tasks/setName</a></li><li data-type='method'><a href="RTMUser.html#~tasks/setURL">tasks/setURL</a></li><li data-type='method'><a href="RTMUser.html#~tasks/uncomplete">tasks/uncomplete</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#setStartDate">setStartDate</a></li></ul>
27
+ </nav>
28
+
29
+ <div id="main">
30
+
31
+ <h1 class="page-title">RTMError</h1>
32
+
33
+
34
+
35
+
36
+
37
+
38
+
39
+ <section>
40
+
41
+ <header>
42
+
43
+ <h2>
44
+ RTMError
45
+ </h2>
46
+
47
+ <div class="class-description"><h3>RTM Error Response</h3>
48
+ <p>This Class represents a failed request to the RTM API Server: the
49
+ RTM API Server returned a response with a status of 'fail'. This
50
+ Class will include the error code and error message from the
51
+ response.</p>
52
+ <p><code>RTMError</code> extends <a href="RTMResponse.html">RTMResponse</a></p></div>
53
+
54
+
55
+ </header>
56
+
57
+ <article>
58
+ <div class="container-overview">
59
+
60
+
61
+
62
+
63
+ <h2>Constructor</h2>
64
+
65
+
66
+ <h4 class="name" id="RTMError"><span class="type-signature"></span>new RTMError<span class="signature">(code, msg)</span><span class="type-signature"></span></h4>
67
+
68
+
69
+
70
+
71
+
72
+
73
+ <dl class="details">
74
+
75
+
76
+ <dt class="tag-source">Source:</dt>
77
+ <dd class="tag-source"><ul class="dummy"><li>
78
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line18">line 18</a>
79
+ </li></ul></dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+ </dl>
112
+
113
+
114
+
115
+
116
+
117
+ <div class="description">
118
+ <p>Create a new RTM Error Response</p>
119
+ </div>
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <h5>Parameters:</h5>
132
+
133
+
134
+ <table class="params">
135
+ <thead>
136
+ <tr>
137
+
138
+ <th>Name</th>
139
+
140
+
141
+ <th>Type</th>
142
+
143
+
144
+
145
+
146
+
147
+ <th class="last">Description</th>
148
+ </tr>
149
+ </thead>
150
+
151
+ <tbody>
152
+
153
+
154
+ <tr>
155
+
156
+ <td class="name"><code>code</code></td>
157
+
158
+
159
+ <td class="type">
160
+
161
+
162
+ <span class="param-type">number</span>
163
+
164
+
165
+
166
+ </td>
167
+
168
+
169
+
170
+
171
+
172
+ <td class="description last"><p>Error Code</p></td>
173
+ </tr>
174
+
175
+
176
+
177
+ <tr>
178
+
179
+ <td class="name"><code>msg</code></td>
180
+
181
+
182
+ <td class="type">
183
+
184
+
185
+ <span class="param-type">string</span>
186
+
187
+
188
+
189
+ </td>
190
+
191
+
192
+
193
+
194
+
195
+ <td class="description last"><p>Error Message</p></td>
196
+ </tr>
197
+
198
+
199
+ </tbody>
200
+ </table>
201
+
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ </div>
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+ <h3 class="subsection-title">Members</h3>
232
+
233
+
234
+
235
+ <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :number</span></h4>
236
+
237
+
238
+
239
+
240
+
241
+ <dl class="details">
242
+
243
+
244
+ <dt class="tag-source">Source:</dt>
245
+ <dd class="tag-source"><ul class="dummy"><li>
246
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line36">line 36</a>
247
+ </li></ul></dd>
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
+ </dl>
280
+
281
+
282
+
283
+
284
+
285
+ <div class="description">
286
+ <p>The RTM Error Code</p>
287
+ </div>
288
+
289
+
290
+
291
+ <h5>Type:</h5>
292
+ <ul>
293
+ <li>
294
+
295
+ <span class="param-type">number</span>
296
+
297
+
298
+ </li>
299
+ </ul>
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+ <h4 class="name" id="msg"><span class="type-signature"></span>msg<span class="type-signature"> :string</span></h4>
309
+
310
+
311
+
312
+
313
+
314
+ <dl class="details">
315
+
316
+
317
+ <dt class="tag-source">Source:</dt>
318
+ <dd class="tag-source"><ul class="dummy"><li>
319
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line44">line 44</a>
320
+ </li></ul></dd>
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
+ </dl>
353
+
354
+
355
+
356
+
357
+
358
+ <div class="description">
359
+ <p>The RTM Error Message</p>
360
+ </div>
361
+
362
+
363
+
364
+ <h5>Type:</h5>
365
+ <ul>
366
+ <li>
367
+
368
+ <span class="param-type">string</span>
369
+
370
+
371
+ </li>
372
+ </ul>
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+ <h3 class="subsection-title">Methods</h3>
384
+
385
+
386
+
387
+
388
+
389
+
390
+ <h4 class="name" id=".networkError"><span class="type-signature">(static) </span>networkError<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="RTMError.html">RTMError</a>}</span></h4>
391
+
392
+
393
+
394
+
395
+
396
+
397
+ <dl class="details">
398
+
399
+
400
+ <dt class="tag-source">Source:</dt>
401
+ <dd class="tag-source"><ul class="dummy"><li>
402
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line67">line 67</a>
403
+ </li></ul></dd>
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
+ </dl>
436
+
437
+
438
+
439
+
440
+
441
+ <div class="description">
442
+ <p>Create a new <code>RTMError</code> that represents a network error.</p>
443
+ <p>Error Code: <code>-1</code></p>
444
+ </div>
445
+
446
+
447
+
448
+
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+ <h5>Returns:</h5>
469
+
470
+
471
+
472
+
473
+ <dl class="param-type">
474
+ <dt>
475
+ Type
476
+ </dt>
477
+ <dd>
478
+
479
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
480
+
481
+
482
+ </dd>
483
+ </dl>
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+ <h4 class="name" id=".rateLimitError"><span class="type-signature">(static) </span>rateLimitError<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="RTMError.html">RTMError</a>}</span></h4>
494
+
495
+
496
+
497
+
498
+
499
+
500
+ <dl class="details">
501
+
502
+
503
+ <dt class="tag-source">Source:</dt>
504
+ <dd class="tag-source"><ul class="dummy"><li>
505
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line99">line 99</a>
506
+ </li></ul></dd>
507
+
508
+
509
+
510
+
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+ </dl>
539
+
540
+
541
+
542
+
543
+
544
+ <div class="description">
545
+ <p>Create a new <code>RTMError</code> that represents an RTM API Rate Limit (the RTM API
546
+ returned a HTTP Status code of <code>503</code>).</p>
547
+ <p>Error Code: <code>-4</code></p>
548
+ </div>
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+ <h5>Returns:</h5>
573
+
574
+
575
+
576
+
577
+ <dl class="param-type">
578
+ <dt>
579
+ Type
580
+ </dt>
581
+ <dd>
582
+
583
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
584
+
585
+
586
+ </dd>
587
+ </dl>
588
+
589
+
590
+
591
+
592
+
593
+
594
+
595
+
596
+
597
+ <h4 class="name" id=".referenceError"><span class="type-signature">(static) </span>referenceError<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="RTMError.html">RTMError</a>}</span></h4>
598
+
599
+
600
+
601
+
602
+
603
+
604
+ <dl class="details">
605
+
606
+
607
+ <dt class="tag-source">Source:</dt>
608
+ <dd class="tag-source"><ul class="dummy"><li>
609
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line88">line 88</a>
610
+ </li></ul></dd>
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+
623
+
624
+
625
+
626
+
627
+
628
+
629
+
630
+
631
+
632
+
633
+
634
+
635
+
636
+
637
+
638
+
639
+
640
+
641
+
642
+ </dl>
643
+
644
+
645
+
646
+
647
+
648
+ <div class="description">
649
+ <p>Create a new <code>RTMError</code> that represents an index error (ie, task index is out
650
+ of range).</p>
651
+ <p>Error Code: <code>-3</code></p>
652
+ </div>
653
+
654
+
655
+
656
+
657
+
658
+
659
+
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+
673
+
674
+
675
+
676
+ <h5>Returns:</h5>
677
+
678
+
679
+
680
+
681
+ <dl class="param-type">
682
+ <dt>
683
+ Type
684
+ </dt>
685
+ <dd>
686
+
687
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
688
+
689
+
690
+ </dd>
691
+ </dl>
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+ <h4 class="name" id=".responseError"><span class="type-signature">(static) </span>responseError<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="RTMError.html">RTMError</a>}</span></h4>
702
+
703
+
704
+
705
+
706
+
707
+
708
+ <dl class="details">
709
+
710
+
711
+ <dt class="tag-source">Source:</dt>
712
+ <dd class="tag-source"><ul class="dummy"><li>
713
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line77">line 77</a>
714
+ </li></ul></dd>
715
+
716
+
717
+
718
+
719
+
720
+
721
+
722
+
723
+
724
+
725
+
726
+
727
+
728
+
729
+
730
+
731
+
732
+
733
+
734
+
735
+
736
+
737
+
738
+
739
+
740
+
741
+
742
+
743
+
744
+
745
+
746
+ </dl>
747
+
748
+
749
+
750
+
751
+
752
+ <div class="description">
753
+ <p>Create a new <code>RTMError</code> that represents an API response error.</p>
754
+ <p>Error Code: <code>-2</code></p>
755
+ </div>
756
+
757
+
758
+
759
+
760
+
761
+
762
+
763
+
764
+
765
+
766
+
767
+
768
+
769
+
770
+
771
+
772
+
773
+
774
+
775
+
776
+
777
+
778
+
779
+ <h5>Returns:</h5>
780
+
781
+
782
+
783
+
784
+ <dl class="param-type">
785
+ <dt>
786
+ Type
787
+ </dt>
788
+ <dd>
789
+
790
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
791
+
792
+
793
+ </dd>
794
+ </dl>
795
+
796
+
797
+
798
+
799
+
800
+
801
+
802
+
803
+
804
+ <h4 class="name" id=".serverError"><span class="type-signature">(static) </span>serverError<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="RTMError.html">RTMError</a>}</span></h4>
805
+
806
+
807
+
808
+
809
+
810
+
811
+ <dl class="details">
812
+
813
+
814
+ <dt class="tag-source">Source:</dt>
815
+ <dd class="tag-source"><ul class="dummy"><li>
816
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line110">line 110</a>
817
+ </li></ul></dd>
818
+
819
+
820
+
821
+
822
+
823
+
824
+
825
+
826
+
827
+
828
+
829
+
830
+
831
+
832
+
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+
844
+
845
+
846
+
847
+
848
+
849
+ </dl>
850
+
851
+
852
+
853
+
854
+
855
+ <div class="description">
856
+ <p>Create a new <code>RTMError</code> that represents an RTM API Server Error (the RTM API
857
+ returned a HTTP Status code of <code>5xx</code> - excluding <code>503</code>).</p>
858
+ <p>Error Code: <code>-5</code></p>
859
+ </div>
860
+
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+
872
+
873
+
874
+
875
+
876
+
877
+
878
+
879
+
880
+
881
+
882
+
883
+ <h5>Returns:</h5>
884
+
885
+
886
+
887
+
888
+ <dl class="param-type">
889
+ <dt>
890
+ Type
891
+ </dt>
892
+ <dd>
893
+
894
+ <span class="param-type"><a href="RTMError.html">RTMError</a></span>
895
+
896
+
897
+ </dd>
898
+ </dl>
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+
907
+
908
+ <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
909
+
910
+
911
+
912
+
913
+
914
+
915
+ <dl class="details">
916
+
917
+
918
+ <dt class="tag-source">Source:</dt>
919
+ <dd class="tag-source"><ul class="dummy"><li>
920
+ <a href="response_error.js.html">response/error.js</a>, <a href="response_error.js.html#line52">line 52</a>
921
+ </li></ul></dd>
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+
939
+
940
+
941
+
942
+
943
+
944
+
945
+
946
+
947
+
948
+
949
+
950
+
951
+
952
+
953
+ </dl>
954
+
955
+
956
+
957
+
958
+
959
+ <div class="description">
960
+ <p>Get a String representation of the Error</p>
961
+ </div>
962
+
963
+
964
+
965
+
966
+
967
+
968
+
969
+
970
+
971
+
972
+
973
+
974
+
975
+
976
+
977
+
978
+
979
+
980
+
981
+
982
+
983
+
984
+
985
+ <h5>Returns:</h5>
986
+
987
+
988
+
989
+
990
+ <dl class="param-type">
991
+ <dt>
992
+ Type
993
+ </dt>
994
+ <dd>
995
+
996
+ <span class="param-type">string</span>
997
+
998
+
999
+ </dd>
1000
+ </dl>
1001
+
1002
+
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+ </article>
1012
+
1013
+ </section>
1014
+
1015
+
1016
+
1017
+
1018
+ </div>
1019
+
1020
+ <br class="clear">
1021
+
1022
+ <footer>
1023
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a> on Mon Sep 05 2022 15:26:15 GMT-0400 (Eastern Daylight Time) using the <a href="https://github.com/dwaring87/docdash">@dwaring87/docdash</a> theme.
1024
+ </footer>
1025
+
1026
+ <script>prettyPrint();</script>
1027
+ <script src="scripts/linenumber.js"></script>
1028
+ </body>
1029
+ </html>