Skip to content

Commit 18bdd4e

Browse files
jaredmixpaneljaredmixpanel
committed
Update docs
1 parent 3542550 commit 18bdd4e

File tree

5 files changed

+57
-55
lines changed

5 files changed

+57
-55
lines changed

‎docs/Mixpanel.html‎

Lines changed: 32 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,8 @@ <h5>Parameters:</h5>
290290
<dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>since version 1.3.0. To initialize Mixpanel, please use the instance method `init` instead. See the example below:
291291

292292
<pre><code>
293-
const mixpanel = new Mixpanel('your project token');
293+
const trackAutomaticEvents = true;
294+
const mixpanel = new Mixpanel('your project token', trackAutomaticEvents);
294295
mixpanel.init();
295296
</code></pre>
296297

@@ -308,7 +309,7 @@ <h5>Parameters:</h5>
308309

309310
<dt class="tag-source">Source:</dt>
310311
<dd class="tag-source"><ul class="dummy"><li>
311-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a>
312+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line85">line 85</a>
312313
</li></ul></dd>
313314

314315

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

469470
<dt class="tag-source">Source:</dt>
470471
<dd class="tag-source"><ul class="dummy"><li>
471-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line309">line 309</a>
472+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line310">line 310</a>
472473
</li></ul></dd>
473474

474475

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

636637
<dt class="tag-source">Source:</dt>
637638
<dd class="tag-source"><ul class="dummy"><li>
638-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line210">line 210</a>
639+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line211">line 211</a>
639640
</li></ul></dd>
640641

641642

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

729730
<dt class="tag-source">Source:</dt>
730731
<dd class="tag-source"><ul class="dummy"><li>
731-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line417">line 417</a>
732+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line418">line 418</a>
732733
</li></ul></dd>
733734

734735

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

891892
<dt class="tag-source">Source:</dt>
892893
<dd class="tag-source"><ul class="dummy"><li>
893-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line337">line 337</a>
894+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line338">line 338</a>
894895
</li></ul></dd>
895896

896897

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

10281029
<dt class="tag-source">Source:</dt>
10291030
<dd class="tag-source"><ul class="dummy"><li>
1030-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line442">line 442</a>
1031+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line443">line 443</a>
10311032
</li></ul></dd>
10321033

10331034

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

11441145
<dt class="tag-source">Source:</dt>
11451146
<dd class="tag-source"><ul class="dummy"><li>
1146-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line502">line 502</a>
1147+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line503">line 503</a>
11471148
</li></ul></dd>
11481149

11491150

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

12401241
<dt class="tag-source">Source:</dt>
12411242
<dd class="tag-source"><ul class="dummy"><li>
1242-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line489">line 489</a>
1243+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line490">line 490</a>
12431244
</li></ul></dd>
12441245

12451246

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

13581359
<dt class="tag-source">Source:</dt>
13591360
<dd class="tag-source"><ul class="dummy"><li>
1360-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line471">line 471</a>
1361+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line472">line 472</a>
13611362
</li></ul></dd>
13621363

13631364

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

15411542
<dt class="tag-source">Source:</dt>
15421543
<dd class="tag-source"><ul class="dummy"><li>
1543-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line299">line 299</a>
1544+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line300">line 300</a>
15441545
</li></ul></dd>
15451546

15461547

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

16411642
<dt class="tag-source">Source:</dt>
16421643
<dd class="tag-source"><ul class="dummy"><li>
1643-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line249">line 249</a>
1644+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line250">line 250</a>
16441645
</li></ul></dd>
16451646

16461647

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

17551756
<dt class="tag-source">Source:</dt>
17561757
<dd class="tag-source"><ul class="dummy"><li>
1757-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line405">line 405</a>
1758+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line406">line 406</a>
17581759
</li></ul></dd>
17591760

17601761

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

18651866
<dt class="tag-source">Source:</dt>
18661867
<dd class="tag-source"><ul class="dummy"><li>
1867-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
1868+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line148">line 148</a>
18681869
</li></ul></dd>
18691870

18701871

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

20362037
<dt class="tag-source">Source:</dt>
20372038
<dd class="tag-source"><ul class="dummy"><li>
2038-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line190">line 190</a>
2039+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line191">line 191</a>
20392040
</li></ul></dd>
20402041

20412042

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

22862287
<dt class="tag-source">Source:</dt>
22872288
<dd class="tag-source"><ul class="dummy"><li>
2288-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line157">line 157</a>
2289+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line158">line 158</a>
22892290
</li></ul></dd>
22902291

22912292

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

23782379
<dt class="tag-source">Source:</dt>
23792380
<dd class="tag-source"><ul class="dummy"><li>
2380-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line168">line 168</a>
2381+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line169">line 169</a>
23812382
</li></ul></dd>
23822383

23832384

@@ -2524,7 +2525,7 @@ <h5>Parameters:</h5>
25242525

25252526
<dt class="tag-source">Source:</dt>
25262527
<dd class="tag-source"><ul class="dummy"><li>
2527-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line359">line 359</a>
2528+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line360">line 360</a>
25282529
</li></ul></dd>
25292530

25302531

@@ -2664,7 +2665,7 @@ <h5>Parameters:</h5>
26642665

26652666
<dt class="tag-source">Source:</dt>
26662667
<dd class="tag-source"><ul class="dummy"><li>
2667-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line374">line 374</a>
2668+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line375">line 375</a>
26682669
</li></ul></dd>
26692670

26702671

@@ -2824,7 +2825,7 @@ <h5>Parameters:</h5>
28242825

28252826
<dt class="tag-source">Source:</dt>
28262827
<dd class="tag-source"><ul class="dummy"><li>
2827-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line322">line 322</a>
2828+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line323">line 323</a>
28282829
</li></ul></dd>
28292830

28302831

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

29142915
<dt class="tag-source">Source:</dt>
29152916
<dd class="tag-source"><ul class="dummy"><li>
2916-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line453">line 453</a>
2917+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line454">line 454</a>
29172918
</li></ul></dd>
29182919

29192920

@@ -3051,7 +3052,7 @@ <h5>Parameters:</h5>
30513052

30523053
<dt class="tag-source">Source:</dt>
30533054
<dd class="tag-source"><ul class="dummy"><li>
3054-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line121">line 121</a>
3055+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line122">line 122</a>
30553056
</li></ul></dd>
30563057

30573058

@@ -3211,7 +3212,7 @@ <h5>Parameters:</h5>
32113212

32123213
<dt class="tag-source">Source:</dt>
32133214
<dd class="tag-source"><ul class="dummy"><li>
3214-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line283">line 283</a>
3215+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line284">line 284</a>
32153216
</li></ul></dd>
32163217

32173218

@@ -3350,7 +3351,7 @@ <h5>Parameters:</h5>
33503351

33513352
<dt class="tag-source">Source:</dt>
33523353
<dd class="tag-source"><ul class="dummy"><li>
3353-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line110">line 110</a>
3354+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line111">line 111</a>
33543355
</li></ul></dd>
33553356

33563357

@@ -3489,7 +3490,7 @@ <h5>Parameters:</h5>
34893490

34903491
<dt class="tag-source">Source:</dt>
34913492
<dd class="tag-source"><ul class="dummy"><li>
3492-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line98">line 98</a>
3493+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
34933494
</li></ul></dd>
34943495

34953496

@@ -3629,7 +3630,7 @@ <h5>Parameters:</h5>
36293630

36303631
<dt class="tag-source">Source:</dt>
36313632
<dd class="tag-source"><ul class="dummy"><li>
3632-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line138">line 138</a>
3633+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line139">line 139</a>
36333634
</li></ul></dd>
36343635

36353636

@@ -3768,7 +3769,7 @@ <h5>Parameters:</h5>
37683769

37693770
<dt class="tag-source">Source:</dt>
37703771
<dd class="tag-source"><ul class="dummy"><li>
3771-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line428">line 428</a>
3772+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line429">line 429</a>
37723773
</li></ul></dd>
37733774

37743775

@@ -3934,7 +3935,7 @@ <h5>Parameters:</h5>
39343935

39353936
<dt class="tag-source">Source:</dt>
39363937
<dd class="tag-source"><ul class="dummy"><li>
3937-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line232">line 232</a>
3938+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line233">line 233</a>
39383939
</li></ul></dd>
39393940

39403941

@@ -4123,7 +4124,7 @@ <h5>Parameters:</h5>
41234124

41244125
<dt class="tag-source">Source:</dt>
41254126
<dd class="tag-source"><ul class="dummy"><li>
4126-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line267">line 267</a>
4127+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line268">line 268</a>
41274128
</li></ul></dd>
41284129

41294130

@@ -4264,7 +4265,7 @@ <h5>Parameters:</h5>
42644265

42654266
<dt class="tag-source">Source:</dt>
42664267
<dd class="tag-source"><ul class="dummy"><li>
4267-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line390">line 390</a>
4268+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line391">line 391</a>
42684269
</li></ul></dd>
42694270

42704271

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

43184319
<footer>
4319-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Mon Sep 12 2022 12:35:41 GMT-0700 (Pacific Daylight Time)
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)
43204321
</footer>
43214322

43224323
<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#line719">line 719</a>
98+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line720">line 720</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#line790">line 790</a>
287+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line791">line 791</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#line738">line 738</a>
449+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line739">line 739</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#line757">line 757</a>
609+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line758">line 758</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#line806">line 806</a>
771+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line807">line 807</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#line775">line 775</a>
908+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line776">line 776</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.10</a> on Mon Sep 12 2022 12:35:41 GMT-0700 (Pacific Daylight Time)
960+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Wed Sep 14 2022 09:05:10 GMT-0700 (Pacific Daylight Time)
961961
</footer>
962962

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

0 commit comments

Comments
 (0)