Skip to content

Commit 4b75623

Browse files
zihejiazihejia
committed
Update docs
1 parent dbf17e6 commit 4b75623

File tree

5 files changed

+109
-119
lines changed

5 files changed

+109
-119
lines changed

‎docs/Mixpanel.html‎

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ <h4 class="name" id="Mixpanel"><span class="type-signature"></span>new Mixpanel<
9393

9494
<dt class="tag-source">Source:</dt>
9595
<dd class="tag-source"><ul class="dummy"><li>
96-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line46">line 46</a>
96+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line43">line 43</a>
9797
</li></ul></dd>
9898

9999

@@ -239,8 +239,7 @@ <h5>Parameters:</h5>
239239

240240

241241

242-
<td class="description last">Whether or not Mixpanel can start tracking by default. See
243-
optOutTracking()</td>
242+
<td class="description last">Whether or not Mixpanel can start tracking by default. See optOutTracking()</td>
244243
</tr>
245244

246245

@@ -281,7 +280,7 @@ <h5>Parameters:</h5>
281280

282281
<dt class="tag-source">Source:</dt>
283282
<dd class="tag-source"><ul class="dummy"><li>
284-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line64">line 64</a>
283+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line61">line 61</a>
285284
</li></ul></dd>
286285

287286

@@ -441,7 +440,7 @@ <h5>Parameters:</h5>
441440

442441
<dt class="tag-source">Source:</dt>
443442
<dd class="tag-source"><ul class="dummy"><li>
444-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line273">line 273</a>
443+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line266">line 266</a>
445444
</li></ul></dd>
446445

447446

@@ -608,7 +607,7 @@ <h5>Parameters:</h5>
608607

609608
<dt class="tag-source">Source:</dt>
610609
<dd class="tag-source"><ul class="dummy"><li>
611-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line170">line 170</a>
610+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line167">line 167</a>
612611
</li></ul></dd>
613612

614613

@@ -701,7 +700,7 @@ <h4 class="name" id="clearSuperProperties"><span class="type-signature"></span>c
701700

702701
<dt class="tag-source">Source:</dt>
703702
<dd class="tag-source"><ul class="dummy"><li>
704-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line383">line 383</a>
703+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line374">line 374</a>
705704
</li></ul></dd>
706705

707706

@@ -863,7 +862,7 @@ <h5>Parameters:</h5>
863862

864863
<dt class="tag-source">Source:</dt>
865864
<dd class="tag-source"><ul class="dummy"><li>
866-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line303">line 303</a>
865+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line294">line 294</a>
867866
</li></ul></dd>
868867

869868

@@ -899,7 +898,7 @@ <h5>Parameters:</h5>
899898

900899

901900

902-
<h4 class="name" id="eventElapsedTime"><span class="type-signature"></span>eventElapsedTime<span class="signature">(eventName)</span><span class="type-signature"> &rarr; {number}</span></h4>
901+
<h4 class="name" id="eventElapsedTime"><span class="type-signature"></span>eventElapsedTime<span class="signature">(eventName)</span><span class="type-signature"> &rarr; {Promise.&lt;number>}</span></h4>
903902

904903

905904

@@ -1000,7 +999,7 @@ <h5>Parameters:</h5>
1000999

10011000
<dt class="tag-source">Source:</dt>
10021001
<dd class="tag-source"><ul class="dummy"><li>
1003-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line408">line 408</a>
1002+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line399">line 399</a>
10041003
</li></ul></dd>
10051004

10061005

@@ -1040,7 +1039,7 @@ <h5>Returns:</h5>
10401039
</dt>
10411040
<dd>
10421041

1043-
<span class="param-type">number</span>
1042+
<span class="param-type">Promise.&lt;number></span>
10441043

10451044

10461045
</dd>
@@ -1116,7 +1115,7 @@ <h4 class="name" id="flush"><span class="type-signature"></span>flush<span class
11161115

11171116
<dt class="tag-source">Source:</dt>
11181117
<dd class="tag-source"><ul class="dummy"><li>
1119-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line450">line 450</a>
1118+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line441">line 441</a>
11201119
</li></ul></dd>
11211120

11221121

@@ -1212,7 +1211,7 @@ <h4 class="name" id="getDistinctId"><span class="type-signature"></span>getDisti
12121211

12131212
<dt class="tag-source">Source:</dt>
12141213
<dd class="tag-source"><ul class="dummy"><li>
1215-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line437">line 437</a>
1214+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line428">line 428</a>
12161215
</li></ul></dd>
12171216

12181217

@@ -1395,7 +1394,7 @@ <h5>Parameters:</h5>
13951394

13961395
<dt class="tag-source">Source:</dt>
13971396
<dd class="tag-source"><ul class="dummy"><li>
1398-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line263">line 263</a>
1397+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line256">line 256</a>
13991398
</li></ul></dd>
14001399

14011400

@@ -1495,7 +1494,7 @@ <h4 class="name" id="getPeople"><span class="type-signature"></span>getPeople<sp
14951494

14961495
<dt class="tag-source">Source:</dt>
14971496
<dd class="tag-source"><ul class="dummy"><li>
1498-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line211">line 211</a>
1497+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line206">line 206</a>
14991498
</li></ul></dd>
15001499

15011500

@@ -1554,7 +1553,7 @@ <h5>Returns:</h5>
15541553

15551554

15561555

1557-
<h4 class="name" id="getSuperProperties"><span class="type-signature"></span>getSuperProperties<span class="signature">()</span><span class="type-signature"> &rarr; {object}</span></h4>
1556+
<h4 class="name" id="getSuperProperties"><span class="type-signature"></span>getSuperProperties<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span></h4>
15581557

15591558

15601559

@@ -1609,7 +1608,7 @@ <h4 class="name" id="getSuperProperties"><span class="type-signature"></span>get
16091608

16101609
<dt class="tag-source">Source:</dt>
16111610
<dd class="tag-source"><ul class="dummy"><li>
1612-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line371">line 371</a>
1611+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line362">line 362</a>
16131612
</li></ul></dd>
16141613

16151614

@@ -1649,7 +1648,7 @@ <h5>Returns:</h5>
16491648
</dt>
16501649
<dd>
16511650

1652-
<span class="param-type">object</span>
1651+
<span class="param-type">Promise.&lt;object></span>
16531652

16541653

16551654
</dd>
@@ -1667,7 +1666,7 @@ <h5>Returns:</h5>
16671666

16681667

16691668

1670-
<h4 class="name" id="hasOptedOutTracking"><span class="type-signature"></span>hasOptedOutTracking<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
1669+
<h4 class="name" id="hasOptedOutTracking"><span class="type-signature"></span>hasOptedOutTracking<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>
16711670

16721671

16731672

@@ -1719,7 +1718,7 @@ <h4 class="name" id="hasOptedOutTracking"><span class="type-signature"></span>ha
17191718

17201719
<dt class="tag-source">Source:</dt>
17211720
<dd class="tag-source"><ul class="dummy"><li>
1722-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line107">line 107</a>
1721+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line104">line 104</a>
17231722
</li></ul></dd>
17241723

17251724

@@ -1759,7 +1758,7 @@ <h5>Returns:</h5>
17591758
</dt>
17601759
<dd>
17611760

1762-
<span class="param-type">boolean</span>
1761+
<span class="param-type">Promise.&lt;boolean></span>
17631762

17641763

17651764
</dd>
@@ -1890,7 +1889,7 @@ <h5>Parameters:</h5>
18901889

18911890
<dt class="tag-source">Source:</dt>
18921891
<dd class="tag-source"><ul class="dummy"><li>
1893-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line150">line 150</a>
1892+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
18941893
</li></ul></dd>
18951894

18961895

@@ -1980,7 +1979,7 @@ <h4 class="name" id="optInTracking"><span class="type-signature"></span>optInTra
19801979

19811980
<dt class="tag-source">Source:</dt>
19821981
<dd class="tag-source"><ul class="dummy"><li>
1983-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line117">line 117</a>
1982+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line114">line 114</a>
19841983
</li></ul></dd>
19851984

19861985

@@ -2072,7 +2071,7 @@ <h4 class="name" id="optOutTracking"><span class="type-signature"></span>optOutT
20722071

20732072
<dt class="tag-source">Source:</dt>
20742073
<dd class="tag-source"><ul class="dummy"><li>
2075-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line128">line 128</a>
2074+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line125">line 125</a>
20762075
</li></ul></dd>
20772076

20782077

@@ -2219,7 +2218,7 @@ <h5>Parameters:</h5>
22192218

22202219
<dt class="tag-source">Source:</dt>
22212220
<dd class="tag-source"><ul class="dummy"><li>
2222-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line325">line 325</a>
2221+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line316">line 316</a>
22232222
</li></ul></dd>
22242223

22252224

@@ -2359,7 +2358,7 @@ <h5>Parameters:</h5>
23592358

23602359
<dt class="tag-source">Source:</dt>
23612360
<dd class="tag-source"><ul class="dummy"><li>
2362-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line340">line 340</a>
2361+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line331">line 331</a>
23632362
</li></ul></dd>
23642363

23652364

@@ -2519,7 +2518,7 @@ <h5>Parameters:</h5>
25192518

25202519
<dt class="tag-source">Source:</dt>
25212520
<dd class="tag-source"><ul class="dummy"><li>
2522-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line287">line 287</a>
2521+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line279">line 279</a>
25232522
</li></ul></dd>
25242523

25252524

@@ -2608,7 +2607,7 @@ <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class
26082607

26092608
<dt class="tag-source">Source:</dt>
26102609
<dd class="tag-source"><ul class="dummy"><li>
2611-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line419">line 419</a>
2610+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line410">line 410</a>
26122611
</li></ul></dd>
26132612

26142613

@@ -2768,7 +2767,7 @@ <h5>Parameters:</h5>
27682767

27692768
<dt class="tag-source">Source:</dt>
27702769
<dd class="tag-source"><ul class="dummy"><li>
2771-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line246">line 246</a>
2770+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line240">line 240</a>
27722771
</li></ul></dd>
27732772

27742773

@@ -2909,7 +2908,7 @@ <h5>Parameters:</h5>
29092908

29102909
<dt class="tag-source">Source:</dt>
29112910
<dd class="tag-source"><ul class="dummy"><li>
2912-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line96">line 96</a>
2911+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
29132912
</li></ul></dd>
29142913

29152914

@@ -3050,7 +3049,7 @@ <h5>Parameters:</h5>
30503049

30513050
<dt class="tag-source">Source:</dt>
30523051
<dd class="tag-source"><ul class="dummy"><li>
3053-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line80">line 80</a>
3052+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line77">line 77</a>
30543053
</li></ul></dd>
30553054

30563055

@@ -3189,7 +3188,7 @@ <h5>Parameters:</h5>
31893188

31903189
<dt class="tag-source">Source:</dt>
31913190
<dd class="tag-source"><ul class="dummy"><li>
3192-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line394">line 394</a>
3191+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line385">line 385</a>
31933192
</li></ul></dd>
31943193

31953194

@@ -3355,7 +3354,7 @@ <h5>Parameters:</h5>
33553354

33563355
<dt class="tag-source">Source:</dt>
33573356
<dd class="tag-source"><ul class="dummy"><li>
3358-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line193">line 193</a>
3357+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
33593358
</li></ul></dd>
33603359

33613360

@@ -3544,7 +3543,7 @@ <h5>Parameters:</h5>
35443543

35453544
<dt class="tag-source">Source:</dt>
35463545
<dd class="tag-source"><ul class="dummy"><li>
3547-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line229">line 229</a>
3546+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line224">line 224</a>
35483547
</li></ul></dd>
35493548

35503549

@@ -3685,7 +3684,7 @@ <h5>Parameters:</h5>
36853684

36863685
<dt class="tag-source">Source:</dt>
36873686
<dd class="tag-source"><ul class="dummy"><li>
3688-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line356">line 356</a>
3687+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line347">line 347</a>
36893688
</li></ul></dd>
36903689

36913690

@@ -3737,7 +3736,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Mixpanel.
37373736
<br class="clear">
37383737

37393738
<footer>
3740-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Jan 27 2021 17:00:26 GMT-0800 (Pacific Standard Time)
3739+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Mar 03 2021 11:54:48 GMT-0800 (Pacific Standard Time)
37413740
</footer>
37423741

37433742
<script> prettyPrint(); </script>

‎docs/MixpanelGroup.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ <h4 class="name" id="MixpanelGroup"><span class="type-signature"></span>new Mixp
9595

9696
<dt class="tag-source">Source:</dt>
9797
<dd class="tag-source"><ul class="dummy"><li>
98-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line667">line 667</a>
98+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line658">line 658</a>
9999
</li></ul></dd>
100100

101101

@@ -284,7 +284,7 @@ <h5>Parameters:</h5>
284284

285285
<dt class="tag-source">Source:</dt>
286286
<dd class="tag-source"><ul class="dummy"><li>
287-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line738">line 738</a>
287+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line729">line 729</a>
288288
</li></ul></dd>
289289

290290

@@ -446,7 +446,7 @@ <h5>Parameters:</h5>
446446

447447
<dt class="tag-source">Source:</dt>
448448
<dd class="tag-source"><ul class="dummy"><li>
449-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line686">line 686</a>
449+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line677">line 677</a>
450450
</li></ul></dd>
451451

452452

@@ -606,7 +606,7 @@ <h5>Parameters:</h5>
606606

607607
<dt class="tag-source">Source:</dt>
608608
<dd class="tag-source"><ul class="dummy"><li>
609-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line705">line 705</a>
609+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line696">line 696</a>
610610
</li></ul></dd>
611611

612612

@@ -768,7 +768,7 @@ <h5>Parameters:</h5>
768768

769769
<dt class="tag-source">Source:</dt>
770770
<dd class="tag-source"><ul class="dummy"><li>
771-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line754">line 754</a>
771+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line745">line 745</a>
772772
</li></ul></dd>
773773

774774

@@ -905,7 +905,7 @@ <h5>Parameters:</h5>
905905

906906
<dt class="tag-source">Source:</dt>
907907
<dd class="tag-source"><ul class="dummy"><li>
908-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line723">line 723</a>
908+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line714">line 714</a>
909909
</li></ul></dd>
910910

911911

@@ -957,7 +957,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Mixpanel.
957957
<br class="clear">
958958

959959
<footer>
960-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Jan 27 2021 17:00:26 GMT-0800 (Pacific Standard Time)
960+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Mar 03 2021 11:54:48 GMT-0800 (Pacific Standard Time)
961961
</footer>
962962

963963
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)