Skip to content

Commit ff44b72

Browse files
jaredmixpaneljaredmixpanel
committed
Update docs
1 parent a5aed42 commit ff44b72

File tree

5 files changed

+95
-66
lines changed

5 files changed

+95
-66
lines changed

‎docs/Mixpanel.html‎

Lines changed: 60 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ <h3 class="subsection-title">Methods</h3>
156156

157157

158158

159-
<h4 class="name" id=".init"><span class="type-signature">(async, static) </span>init<span class="signature">(token, Optional)</span><span class="type-signature"></span></h4>
159+
<h4 class="name" id=".init"><span class="type-signature">(async, static) </span>init<span class="signature">(token, trackAutomaticEvents, Optional)</span><span class="type-signature"></span></h4>
160160

161161

162162

@@ -217,6 +217,29 @@ <h5>Parameters:</h5>
217217

218218

219219

220+
<tr>
221+
222+
<td class="name"><code>trackAutomaticEvents</code></td>
223+
224+
225+
<td class="type">
226+
227+
228+
<span class="param-type">boolean</span>
229+
230+
231+
232+
</td>
233+
234+
235+
236+
237+
238+
<td class="description last">Whether or not to automatically track common mobile events</td>
239+
</tr>
240+
241+
242+
220243
<tr>
221244

222245
<td class="name"><code>Optional</code></td>
@@ -285,7 +308,7 @@ <h5>Parameters:</h5>
285308

286309
<dt class="tag-source">Source:</dt>
287310
<dd class="tag-source"><ul class="dummy"><li>
288-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line79">line 79</a>
311+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a>
289312
</li></ul></dd>
290313

291314

@@ -445,7 +468,7 @@ <h5>Parameters:</h5>
445468

446469
<dt class="tag-source">Source:</dt>
447470
<dd class="tag-source"><ul class="dummy"><li>
448-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line304">line 304</a>
471+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line309">line 309</a>
449472
</li></ul></dd>
450473

451474

@@ -612,7 +635,7 @@ <h5>Parameters:</h5>
612635

613636
<dt class="tag-source">Source:</dt>
614637
<dd class="tag-source"><ul class="dummy"><li>
615-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line205">line 205</a>
638+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line210">line 210</a>
616639
</li></ul></dd>
617640

618641

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

706729
<dt class="tag-source">Source:</dt>
707730
<dd class="tag-source"><ul class="dummy"><li>
708-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line412">line 412</a>
731+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line417">line 417</a>
709732
</li></ul></dd>
710733

711734

@@ -867,7 +890,7 @@ <h5>Parameters:</h5>
867890

868891
<dt class="tag-source">Source:</dt>
869892
<dd class="tag-source"><ul class="dummy"><li>
870-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line332">line 332</a>
893+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line337">line 337</a>
871894
</li></ul></dd>
872895

873896

@@ -1004,7 +1027,7 @@ <h5>Parameters:</h5>
10041027

10051028
<dt class="tag-source">Source:</dt>
10061029
<dd class="tag-source"><ul class="dummy"><li>
1007-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line437">line 437</a>
1030+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line442">line 442</a>
10081031
</li></ul></dd>
10091032

10101033

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

11211144
<dt class="tag-source">Source:</dt>
11221145
<dd class="tag-source"><ul class="dummy"><li>
1123-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line497">line 497</a>
1146+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line502">line 502</a>
11241147
</li></ul></dd>
11251148

11261149

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

12171240
<dt class="tag-source">Source:</dt>
12181241
<dd class="tag-source"><ul class="dummy"><li>
1219-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line484">line 484</a>
1242+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line489">line 489</a>
12201243
</li></ul></dd>
12211244

12221245

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

13351358
<dt class="tag-source">Source:</dt>
13361359
<dd class="tag-source"><ul class="dummy"><li>
1337-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line466">line 466</a>
1360+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line471">line 471</a>
13381361
</li></ul></dd>
13391362

13401363

@@ -1517,7 +1540,7 @@ <h5>Parameters:</h5>
15171540

15181541
<dt class="tag-source">Source:</dt>
15191542
<dd class="tag-source"><ul class="dummy"><li>
1520-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line294">line 294</a>
1543+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line299">line 299</a>
15211544
</li></ul></dd>
15221545

15231546

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

16181641
<dt class="tag-source">Source:</dt>
16191642
<dd class="tag-source"><ul class="dummy"><li>
1620-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line244">line 244</a>
1643+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line249">line 249</a>
16211644
</li></ul></dd>
16221645

16231646

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

17321755
<dt class="tag-source">Source:</dt>
17331756
<dd class="tag-source"><ul class="dummy"><li>
1734-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line400">line 400</a>
1757+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line405">line 405</a>
17351758
</li></ul></dd>
17361759

17371760

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

18421865
<dt class="tag-source">Source:</dt>
18431866
<dd class="tag-source"><ul class="dummy"><li>
1844-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line142">line 142</a>
1867+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
18451868
</li></ul></dd>
18461869

18471870

@@ -2012,7 +2035,7 @@ <h5>Parameters:</h5>
20122035

20132036
<dt class="tag-source">Source:</dt>
20142037
<dd class="tag-source"><ul class="dummy"><li>
2015-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line185">line 185</a>
2038+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line190">line 190</a>
20162039
</li></ul></dd>
20172040

20182041

@@ -2048,7 +2071,7 @@ <h5>Parameters:</h5>
20482071

20492072

20502073

2051-
<h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">(Optional, Optional)</span><span class="type-signature"></span></h4>
2074+
<h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">(optOutTrackingDefault, superProperties)</span><span class="type-signature"></span></h4>
20522075

20532076

20542077

@@ -2092,7 +2115,7 @@ <h5>Parameters:</h5>
20922115

20932116
<tr>
20942117

2095-
<td class="name"><code>Optional</code></td>
2118+
<td class="name"><code>optOutTrackingDefault</code></td>
20962119

20972120

20982121
<td class="type">
@@ -2108,14 +2131,14 @@ <h5>Parameters:</h5>
21082131

21092132

21102133

2111-
<td class="description last">Whether or not Mixpanel can start tracking by default. See optOutTracking()</td>
2134+
<td class="description last">Optional Whether or not Mixpanel can start tracking by default. See optOutTracking()</td>
21122135
</tr>
21132136

21142137

21152138

21162139
<tr>
21172140

2118-
<td class="name"><code>Optional</code></td>
2141+
<td class="name"><code>superProperties</code></td>
21192142

21202143

21212144
<td class="type">
@@ -2131,7 +2154,7 @@ <h5>Parameters:</h5>
21312154

21322155

21332156

2134-
<td class="description last">A Map containing the key value pairs of the super properties to register</td>
2157+
<td class="description last">Optional A Map containing the key value pairs of the super properties to register</td>
21352158
</tr>
21362159

21372160

@@ -2172,7 +2195,7 @@ <h5>Parameters:</h5>
21722195

21732196
<dt class="tag-source">Source:</dt>
21742197
<dd class="tag-source"><ul class="dummy"><li>
2175-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line60">line 60</a>
2198+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line64">line 64</a>
21762199
</li></ul></dd>
21772200

21782201

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

22632286
<dt class="tag-source">Source:</dt>
22642287
<dd class="tag-source"><ul class="dummy"><li>
2265-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a>
2288+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line157">line 157</a>
22662289
</li></ul></dd>
22672290

22682291

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

23552378
<dt class="tag-source">Source:</dt>
23562379
<dd class="tag-source"><ul class="dummy"><li>
2357-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line163">line 163</a>
2380+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line168">line 168</a>
23582381
</li></ul></dd>
23592382

23602383

@@ -2501,7 +2524,7 @@ <h5>Parameters:</h5>
25012524

25022525
<dt class="tag-source">Source:</dt>
25032526
<dd class="tag-source"><ul class="dummy"><li>
2504-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line354">line 354</a>
2527+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line359">line 359</a>
25052528
</li></ul></dd>
25062529

25072530

@@ -2641,7 +2664,7 @@ <h5>Parameters:</h5>
26412664

26422665
<dt class="tag-source">Source:</dt>
26432666
<dd class="tag-source"><ul class="dummy"><li>
2644-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line369">line 369</a>
2667+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line374">line 374</a>
26452668
</li></ul></dd>
26462669

26472670

@@ -2801,7 +2824,7 @@ <h5>Parameters:</h5>
28012824

28022825
<dt class="tag-source">Source:</dt>
28032826
<dd class="tag-source"><ul class="dummy"><li>
2804-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line317">line 317</a>
2827+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line322">line 322</a>
28052828
</li></ul></dd>
28062829

28072830

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

28912914
<dt class="tag-source">Source:</dt>
28922915
<dd class="tag-source"><ul class="dummy"><li>
2893-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line448">line 448</a>
2916+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line453">line 453</a>
28942917
</li></ul></dd>
28952918

28962919

@@ -3028,7 +3051,7 @@ <h5>Parameters:</h5>
30283051

30293052
<dt class="tag-source">Source:</dt>
30303053
<dd class="tag-source"><ul class="dummy"><li>
3031-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line116">line 116</a>
3054+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line121">line 121</a>
30323055
</li></ul></dd>
30333056

30343057

@@ -3188,7 +3211,7 @@ <h5>Parameters:</h5>
31883211

31893212
<dt class="tag-source">Source:</dt>
31903213
<dd class="tag-source"><ul class="dummy"><li>
3191-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line278">line 278</a>
3214+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line283">line 283</a>
31923215
</li></ul></dd>
31933216

31943217

@@ -3327,7 +3350,7 @@ <h5>Parameters:</h5>
33273350

33283351
<dt class="tag-source">Source:</dt>
33293352
<dd class="tag-source"><ul class="dummy"><li>
3330-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line105">line 105</a>
3353+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line110">line 110</a>
33313354
</li></ul></dd>
33323355

33333356

@@ -3466,7 +3489,7 @@ <h5>Parameters:</h5>
34663489

34673490
<dt class="tag-source">Source:</dt>
34683491
<dd class="tag-source"><ul class="dummy"><li>
3469-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
3492+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line98">line 98</a>
34703493
</li></ul></dd>
34713494

34723495

@@ -3606,7 +3629,7 @@ <h5>Parameters:</h5>
36063629

36073630
<dt class="tag-source">Source:</dt>
36083631
<dd class="tag-source"><ul class="dummy"><li>
3609-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line133">line 133</a>
3632+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line138">line 138</a>
36103633
</li></ul></dd>
36113634

36123635

@@ -3745,7 +3768,7 @@ <h5>Parameters:</h5>
37453768

37463769
<dt class="tag-source">Source:</dt>
37473770
<dd class="tag-source"><ul class="dummy"><li>
3748-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line423">line 423</a>
3771+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line428">line 428</a>
37493772
</li></ul></dd>
37503773

37513774

@@ -3911,7 +3934,7 @@ <h5>Parameters:</h5>
39113934

39123935
<dt class="tag-source">Source:</dt>
39133936
<dd class="tag-source"><ul class="dummy"><li>
3914-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line227">line 227</a>
3937+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line232">line 232</a>
39153938
</li></ul></dd>
39163939

39173940

@@ -4100,7 +4123,7 @@ <h5>Parameters:</h5>
41004123

41014124
<dt class="tag-source">Source:</dt>
41024125
<dd class="tag-source"><ul class="dummy"><li>
4103-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line262">line 262</a>
4126+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line267">line 267</a>
41044127
</li></ul></dd>
41054128

41064129

@@ -4241,7 +4264,7 @@ <h5>Parameters:</h5>
42414264

42424265
<dt class="tag-source">Source:</dt>
42434266
<dd class="tag-source"><ul class="dummy"><li>
4244-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line385">line 385</a>
4267+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line390">line 390</a>
42454268
</li></ul></dd>
42464269

42474270

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

42954318
<footer>
4296-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Jun 24 2022 15:59:17 GMT-0700 (Pacific Daylight Time)
4319+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Sep 09 2022 15:21:59 GMT-0700 (Pacific Daylight Time)
42974320
</footer>
42984321

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

0 commit comments

Comments
 (0)