Skip to content

Commit 8f99953

Browse files
zihejiazihejia
committed
Update docs
1 parent 4ae3a55 commit 8f99953

File tree

5 files changed

+93
-53
lines changed

5 files changed

+93
-53
lines changed

‎docs/Mixpanel.html‎

Lines changed: 71 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ <h5>Parameters:</h5>
309309

310310
<dt class="tag-source">Source:</dt>
311311
<dd class="tag-source"><ul class="dummy"><li>
312-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line85">line 85</a>
312+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line86">line 86</a>
313313
</li></ul></dd>
314314

315315

@@ -469,7 +469,7 @@ <h5>Parameters:</h5>
469469

470470
<dt class="tag-source">Source:</dt>
471471
<dd class="tag-source"><ul class="dummy"><li>
472-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line310">line 310</a>
472+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line311">line 311</a>
473473
</li></ul></dd>
474474

475475

@@ -636,7 +636,7 @@ <h5>Parameters:</h5>
636636

637637
<dt class="tag-source">Source:</dt>
638638
<dd class="tag-source"><ul class="dummy"><li>
639-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line211">line 211</a>
639+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line212">line 212</a>
640640
</li></ul></dd>
641641

642642

@@ -729,7 +729,7 @@ <h4 class="name" id="clearSuperProperties"><span class="type-signature"></span>c
729729

730730
<dt class="tag-source">Source:</dt>
731731
<dd class="tag-source"><ul class="dummy"><li>
732-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line418">line 418</a>
732+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line419">line 419</a>
733733
</li></ul></dd>
734734

735735

@@ -891,7 +891,7 @@ <h5>Parameters:</h5>
891891

892892
<dt class="tag-source">Source:</dt>
893893
<dd class="tag-source"><ul class="dummy"><li>
894-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line338">line 338</a>
894+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line339">line 339</a>
895895
</li></ul></dd>
896896

897897

@@ -1028,7 +1028,7 @@ <h5>Parameters:</h5>
10281028

10291029
<dt class="tag-source">Source:</dt>
10301030
<dd class="tag-source"><ul class="dummy"><li>
1031-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line443">line 443</a>
1031+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line444">line 444</a>
10321032
</li></ul></dd>
10331033

10341034

@@ -1144,7 +1144,7 @@ <h4 class="name" id="flush"><span class="type-signature"></span>flush<span class
11441144

11451145
<dt class="tag-source">Source:</dt>
11461146
<dd class="tag-source"><ul class="dummy"><li>
1147-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line503">line 503</a>
1147+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line504">line 504</a>
11481148
</li></ul></dd>
11491149

11501150

@@ -1240,7 +1240,7 @@ <h4 class="name" id="getDeviceId"><span class="type-signature"></span>getDeviceI
12401240

12411241
<dt class="tag-source">Source:</dt>
12421242
<dd class="tag-source"><ul class="dummy"><li>
1243-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line490">line 490</a>
1243+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line491">line 491</a>
12441244
</li></ul></dd>
12451245

12461246

@@ -1358,7 +1358,7 @@ <h4 class="name" id="getDistinctId"><span class="type-signature"></span>getDisti
13581358

13591359
<dt class="tag-source">Source:</dt>
13601360
<dd class="tag-source"><ul class="dummy"><li>
1361-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line472">line 472</a>
1361+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line473">line 473</a>
13621362
</li></ul></dd>
13631363

13641364

@@ -1541,7 +1541,7 @@ <h5>Parameters:</h5>
15411541

15421542
<dt class="tag-source">Source:</dt>
15431543
<dd class="tag-source"><ul class="dummy"><li>
1544-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line300">line 300</a>
1544+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line301">line 301</a>
15451545
</li></ul></dd>
15461546

15471547

@@ -1641,7 +1641,7 @@ <h4 class="name" id="getPeople"><span class="type-signature"></span>getPeople<sp
16411641

16421642
<dt class="tag-source">Source:</dt>
16431643
<dd class="tag-source"><ul class="dummy"><li>
1644-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line250">line 250</a>
1644+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line251">line 251</a>
16451645
</li></ul></dd>
16461646

16471647

@@ -1755,7 +1755,7 @@ <h4 class="name" id="getSuperProperties"><span class="type-signature"></span>get
17551755

17561756
<dt class="tag-source">Source:</dt>
17571757
<dd class="tag-source"><ul class="dummy"><li>
1758-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line406">line 406</a>
1758+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line407">line 407</a>
17591759
</li></ul></dd>
17601760

17611761

@@ -1865,7 +1865,7 @@ <h4 class="name" id="hasOptedOutTracking"><span class="type-signature"></span>ha
18651865

18661866
<dt class="tag-source">Source:</dt>
18671867
<dd class="tag-source"><ul class="dummy"><li>
1868-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line148">line 148</a>
1868+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line149">line 149</a>
18691869
</li></ul></dd>
18701870

18711871

@@ -2036,7 +2036,7 @@ <h5>Parameters:</h5>
20362036

20372037
<dt class="tag-source">Source:</dt>
20382038
<dd class="tag-source"><ul class="dummy"><li>
2039-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line191">line 191</a>
2039+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line192">line 192</a>
20402040
</li></ul></dd>
20412041

20422042

@@ -2072,7 +2072,7 @@ <h5>Parameters:</h5>
20722072

20732073

20742074

2075-
<h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">(optOutTrackingDefault, superProperties)</span><span class="type-signature"></span></h4>
2075+
<h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">(optOutTrackingDefault, superProperties, serverURL)</span><span class="type-signature"></span></h4>
20762076

20772077

20782078

@@ -2106,6 +2106,8 @@ <h5>Parameters:</h5>
21062106

21072107

21082108

2109+
<th>Default</th>
2110+
21092111

21102112
<th class="last">Description</th>
21112113
</tr>
@@ -2131,6 +2133,10 @@ <h5>Parameters:</h5>
21312133

21322134

21332135

2136+
<td class="default">
2137+
2138+
</td>
2139+
21342140

21352141
<td class="description last">Optional Whether or not Mixpanel can start tracking by default. See optOutTracking()</td>
21362142
</tr>
@@ -2154,11 +2160,44 @@ <h5>Parameters:</h5>
21542160

21552161

21562162

2163+
<td class="default">
2164+
2165+
</td>
2166+
21572167

21582168
<td class="description last">Optional A Map containing the key value pairs of the super properties to register</td>
21592169
</tr>
21602170

21612171

2172+
2173+
<tr>
2174+
2175+
<td class="name"><code>serverURL</code></td>
2176+
2177+
2178+
<td class="type">
2179+
2180+
2181+
<span class="param-type">string</span>
2182+
2183+
2184+
2185+
</td>
2186+
2187+
2188+
2189+
2190+
<td class="default">
2191+
2192+
https://api.mixpanel.com
2193+
2194+
</td>
2195+
2196+
2197+
<td class="description last">Optional Set the base URL used for Mixpanel API requests. See setServerURL()</td>
2198+
</tr>
2199+
2200+
21622201
</tbody>
21632202
</table>
21642203

@@ -2196,7 +2235,7 @@ <h5>Parameters:</h5>
21962235

21972236
<dt class="tag-source">Source:</dt>
21982237
<dd class="tag-source"><ul class="dummy"><li>
2199-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line64">line 64</a>
2238+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line65">line 65</a>
22002239
</li></ul></dd>
22012240

22022241

@@ -2286,7 +2325,7 @@ <h4 class="name" id="optInTracking"><span class="type-signature"></span>optInTra
22862325

22872326
<dt class="tag-source">Source:</dt>
22882327
<dd class="tag-source"><ul class="dummy"><li>
2289-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line158">line 158</a>
2328+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line159">line 159</a>
22902329
</li></ul></dd>
22912330

22922331

@@ -2378,7 +2417,7 @@ <h4 class="name" id="optOutTracking"><span class="type-signature"></span>optOutT
23782417

23792418
<dt class="tag-source">Source:</dt>
23802419
<dd class="tag-source"><ul class="dummy"><li>
2381-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line169">line 169</a>
2420+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line170">line 170</a>
23822421
</li></ul></dd>
23832422

23842423

@@ -2525,7 +2564,7 @@ <h5>Parameters:</h5>
25252564

25262565
<dt class="tag-source">Source:</dt>
25272566
<dd class="tag-source"><ul class="dummy"><li>
2528-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line360">line 360</a>
2567+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line361">line 361</a>
25292568
</li></ul></dd>
25302569

25312570

@@ -2665,7 +2704,7 @@ <h5>Parameters:</h5>
26652704

26662705
<dt class="tag-source">Source:</dt>
26672706
<dd class="tag-source"><ul class="dummy"><li>
2668-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line375">line 375</a>
2707+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line376">line 376</a>
26692708
</li></ul></dd>
26702709

26712710

@@ -2825,7 +2864,7 @@ <h5>Parameters:</h5>
28252864

28262865
<dt class="tag-source">Source:</dt>
28272866
<dd class="tag-source"><ul class="dummy"><li>
2828-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line323">line 323</a>
2867+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line324">line 324</a>
28292868
</li></ul></dd>
28302869

28312870

@@ -2914,7 +2953,7 @@ <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class
29142953

29152954
<dt class="tag-source">Source:</dt>
29162955
<dd class="tag-source"><ul class="dummy"><li>
2917-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line454">line 454</a>
2956+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line455">line 455</a>
29182957
</li></ul></dd>
29192958

29202959

@@ -3052,7 +3091,7 @@ <h5>Parameters:</h5>
30523091

30533092
<dt class="tag-source">Source:</dt>
30543093
<dd class="tag-source"><ul class="dummy"><li>
3055-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line122">line 122</a>
3094+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line123">line 123</a>
30563095
</li></ul></dd>
30573096

30583097

@@ -3212,7 +3251,7 @@ <h5>Parameters:</h5>
32123251

32133252
<dt class="tag-source">Source:</dt>
32143253
<dd class="tag-source"><ul class="dummy"><li>
3215-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line284">line 284</a>
3254+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line285">line 285</a>
32163255
</li></ul></dd>
32173256

32183257

@@ -3351,7 +3390,7 @@ <h5>Parameters:</h5>
33513390

33523391
<dt class="tag-source">Source:</dt>
33533392
<dd class="tag-source"><ul class="dummy"><li>
3354-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a>
3393+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line112">line 112</a>
33553394
</li></ul></dd>
33563395

33573396

@@ -3490,7 +3529,7 @@ <h5>Parameters:</h5>
34903529

34913530
<dt class="tag-source">Source:</dt>
34923531
<dd class="tag-source"><ul class="dummy"><li>
3493-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
3532+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line100">line 100</a>
34943533
</li></ul></dd>
34953534

34963535

@@ -3630,7 +3669,7 @@ <h5>Parameters:</h5>
36303669

36313670
<dt class="tag-source">Source:</dt>
36323671
<dd class="tag-source"><ul class="dummy"><li>
3633-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line139">line 139</a>
3672+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line140">line 140</a>
36343673
</li></ul></dd>
36353674

36363675

@@ -3769,7 +3808,7 @@ <h5>Parameters:</h5>
37693808

37703809
<dt class="tag-source">Source:</dt>
37713810
<dd class="tag-source"><ul class="dummy"><li>
3772-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line429">line 429</a>
3811+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line430">line 430</a>
37733812
</li></ul></dd>
37743813

37753814

@@ -3935,7 +3974,7 @@ <h5>Parameters:</h5>
39353974

39363975
<dt class="tag-source">Source:</dt>
39373976
<dd class="tag-source"><ul class="dummy"><li>
3938-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line233">line 233</a>
3977+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line234">line 234</a>
39393978
</li></ul></dd>
39403979

39413980

@@ -4124,7 +4163,7 @@ <h5>Parameters:</h5>
41244163

41254164
<dt class="tag-source">Source:</dt>
41264165
<dd class="tag-source"><ul class="dummy"><li>
4127-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line268">line 268</a>
4166+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line269">line 269</a>
41284167
</li></ul></dd>
41294168

41304169

@@ -4265,7 +4304,7 @@ <h5>Parameters:</h5>
42654304

42664305
<dt class="tag-source">Source:</dt>
42674306
<dd class="tag-source"><ul class="dummy"><li>
4268-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line391">line 391</a>
4307+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line392">line 392</a>
42694308
</li></ul></dd>
42704309

42714310

@@ -4317,7 +4356,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Mixpanel.
43174356
<br class="clear">
43184357

43194358
<footer>
4320-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Wed Sep 14 2022 09:05:09 GMT-0700 (Pacific Daylight Time)
4359+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Sun Mar 05 2023 23:39:40 GMT-0800 (Pacific Standard Time)
43214360
</footer>
43224361

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

0 commit comments

Comments
 (0)