Skip to content

Commit bb74b6f

Browse files
zihejiazihejia
committed
Update docs
1 parent 0e0f5c5 commit bb74b6f

File tree

5 files changed

+102
-78
lines changed

5 files changed

+102
-78
lines changed

‎docs/Mixpanel.html‎

Lines changed: 58 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ <h5>Parameters:</h5>
285285

286286
<dt class="tag-source">Source:</dt>
287287
<dd class="tag-source"><ul class="dummy"><li>
288-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line78">line 78</a>
288+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line79">line 79</a>
289289
</li></ul></dd>
290290

291291

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

446446
<dt class="tag-source">Source:</dt>
447447
<dd class="tag-source"><ul class="dummy"><li>
448-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line288">line 288</a>
448+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line289">line 289</a>
449449
</li></ul></dd>
450450

451451

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

613613
<dt class="tag-source">Source:</dt>
614614
<dd class="tag-source"><ul class="dummy"><li>
615-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
615+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line190">line 190</a>
616616
</li></ul></dd>
617617

618618

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

706706
<dt class="tag-source">Source:</dt>
707707
<dd class="tag-source"><ul class="dummy"><li>
708-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line396">line 396</a>
708+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line397">line 397</a>
709709
</li></ul></dd>
710710

711711

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

868868
<dt class="tag-source">Source:</dt>
869869
<dd class="tag-source"><ul class="dummy"><li>
870-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line316">line 316</a>
870+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line317">line 317</a>
871871
</li></ul></dd>
872872

873873

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

10051005
<dt class="tag-source">Source:</dt>
10061006
<dd class="tag-source"><ul class="dummy"><li>
1007-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line421">line 421</a>
1007+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line422">line 422</a>
10081008
</li></ul></dd>
10091009

10101010

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

11211121
<dt class="tag-source">Source:</dt>
11221122
<dd class="tag-source"><ul class="dummy"><li>
1123-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line463">line 463</a>
1123+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line464">line 464</a>
11241124
</li></ul></dd>
11251125

11261126

@@ -1164,13 +1164,13 @@ <h4 class="name" id="getDistinctId"><span class="type-signature"></span>getDisti
11641164

11651165

11661166
<div class="description">
1167-
Returns the current distinct id of the user.
1167+
Returns the current distinct id of the user.
11681168
This is either the id automatically generated by the library or the id that has been passed by a call to identify().
11691169

1170-
example of usage:
1170+
example of usage:
11711171
<pre>
11721172
<code>
1173-
const distinctId = await mixpanel.getDistinctId();
1173+
const distinctId = await mixpanel.getDistinctId();
11741174
</code>
11751175
</pre>
11761176
</div>
@@ -1216,7 +1216,7 @@ <h4 class="name" id="getDistinctId"><span class="type-signature"></span>getDisti
12161216

12171217
<dt class="tag-source">Source:</dt>
12181218
<dd class="tag-source"><ul class="dummy"><li>
1219-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line450">line 450</a>
1219+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line451">line 451</a>
12201220
</li></ul></dd>
12211221

12221222

@@ -1399,7 +1399,7 @@ <h5>Parameters:</h5>
13991399

14001400
<dt class="tag-source">Source:</dt>
14011401
<dd class="tag-source"><ul class="dummy"><li>
1402-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line278">line 278</a>
1402+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line279">line 279</a>
14031403
</li></ul></dd>
14041404

14051405

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

15001500
<dt class="tag-source">Source:</dt>
15011501
<dd class="tag-source"><ul class="dummy"><li>
1502-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line228">line 228</a>
1502+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line229">line 229</a>
15031503
</li></ul></dd>
15041504

15051505

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

16141614
<dt class="tag-source">Source:</dt>
16151615
<dd class="tag-source"><ul class="dummy"><li>
1616-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line384">line 384</a>
1616+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line385">line 385</a>
16171617
</li></ul></dd>
16181618

16191619

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

17241724
<dt class="tag-source">Source:</dt>
17251725
<dd class="tag-source"><ul class="dummy"><li>
1726-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line126">line 126</a>
1726+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line127">line 127</a>
17271727
</li></ul></dd>
17281728

17291729

@@ -1894,7 +1894,7 @@ <h5>Parameters:</h5>
18941894

18951895
<dt class="tag-source">Source:</dt>
18961896
<dd class="tag-source"><ul class="dummy"><li>
1897-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line169">line 169</a>
1897+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line170">line 170</a>
18981898
</li></ul></dd>
18991899

19001900

@@ -1930,7 +1930,7 @@ <h5>Parameters:</h5>
19301930

19311931

19321932

1933-
<h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">(Optional)</span><span class="type-signature"></span></h4>
1933+
<h4 class="name" id="init"><span class="type-signature">(async) </span>init<span class="signature">(Optional, Optional)</span><span class="type-signature"></span></h4>
19341934

19351935

19361936

@@ -1994,6 +1994,29 @@ <h5>Parameters:</h5>
19941994
</tr>
19951995

19961996

1997+
1998+
<tr>
1999+
2000+
<td class="name"><code>Optional</code></td>
2001+
2002+
2003+
<td class="type">
2004+
2005+
2006+
<span class="param-type">object</span>
2007+
2008+
2009+
2010+
</td>
2011+
2012+
2013+
2014+
2015+
2016+
<td class="description last">A Map containing the key value pairs of the super properties to register</td>
2017+
</tr>
2018+
2019+
19972020
</tbody>
19982021
</table>
19992022

@@ -2031,7 +2054,7 @@ <h5>Parameters:</h5>
20312054

20322055
<dt class="tag-source">Source:</dt>
20332056
<dd class="tag-source"><ul class="dummy"><li>
2034-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line59">line 59</a>
2057+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line60">line 60</a>
20352058
</li></ul></dd>
20362059

20372060

@@ -2121,7 +2144,7 @@ <h4 class="name" id="optInTracking"><span class="type-signature"></span>optInTra
21212144

21222145
<dt class="tag-source">Source:</dt>
21232146
<dd class="tag-source"><ul class="dummy"><li>
2124-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line136">line 136</a>
2147+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line137">line 137</a>
21252148
</li></ul></dd>
21262149

21272150

@@ -2213,7 +2236,7 @@ <h4 class="name" id="optOutTracking"><span class="type-signature"></span>optOutT
22132236

22142237
<dt class="tag-source">Source:</dt>
22152238
<dd class="tag-source"><ul class="dummy"><li>
2216-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
2239+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line148">line 148</a>
22172240
</li></ul></dd>
22182241

22192242

@@ -2360,7 +2383,7 @@ <h5>Parameters:</h5>
23602383

23612384
<dt class="tag-source">Source:</dt>
23622385
<dd class="tag-source"><ul class="dummy"><li>
2363-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line338">line 338</a>
2386+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line339">line 339</a>
23642387
</li></ul></dd>
23652388

23662389

@@ -2500,7 +2523,7 @@ <h5>Parameters:</h5>
25002523

25012524
<dt class="tag-source">Source:</dt>
25022525
<dd class="tag-source"><ul class="dummy"><li>
2503-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line353">line 353</a>
2526+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line354">line 354</a>
25042527
</li></ul></dd>
25052528

25062529

@@ -2660,7 +2683,7 @@ <h5>Parameters:</h5>
26602683

26612684
<dt class="tag-source">Source:</dt>
26622685
<dd class="tag-source"><ul class="dummy"><li>
2663-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line301">line 301</a>
2686+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line302">line 302</a>
26642687
</li></ul></dd>
26652688

26662689

@@ -2749,7 +2772,7 @@ <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class
27492772

27502773
<dt class="tag-source">Source:</dt>
27512774
<dd class="tag-source"><ul class="dummy"><li>
2752-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line432">line 432</a>
2775+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line433">line 433</a>
27532776
</li></ul></dd>
27542777

27552778

@@ -2909,7 +2932,7 @@ <h5>Parameters:</h5>
29092932

29102933
<dt class="tag-source">Source:</dt>
29112934
<dd class="tag-source"><ul class="dummy"><li>
2912-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line262">line 262</a>
2935+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line263">line 263</a>
29132936
</li></ul></dd>
29142937

29152938

@@ -3048,7 +3071,7 @@ <h5>Parameters:</h5>
30483071

30493072
<dt class="tag-source">Source:</dt>
30503073
<dd class="tag-source"><ul class="dummy"><li>
3051-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line104">line 104</a>
3074+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line105">line 105</a>
30523075
</li></ul></dd>
30533076

30543077

@@ -3187,7 +3210,7 @@ <h5>Parameters:</h5>
31873210

31883211
<dt class="tag-source">Source:</dt>
31893212
<dd class="tag-source"><ul class="dummy"><li>
3190-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line92">line 92</a>
3213+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line93">line 93</a>
31913214
</li></ul></dd>
31923215

31933216

@@ -3232,7 +3255,7 @@ <h4 class="name" id="setUseIpAddressForGeolocation"><span class="type-signature"
32323255

32333256
<div class="description">
32343257
This controls whether to automatically send the client IP Address as part of event tracking.
3235-
With an IP address, geo-location is possible down to neighborhoods within a city,
3258+
With an IP address, geo-location is possible down to neighborhoods within a city,
32363259
although the Mixpanel Dashboard will just show you city level location specificity.
32373260
</div>
32383261

@@ -3285,7 +3308,7 @@ <h5>Parameters:</h5>
32853308

32863309

32873310

3288-
<td class="description last">whether to automatically send the client IP Address.
3311+
<td class="description last">whether to automatically send the client IP Address.
32893312
Defaults to true.</td>
32903313
</tr>
32913314

@@ -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#line117">line 117</a>
3353+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line118">line 118</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#line407">line 407</a>
3492+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line408">line 408</a>
34703493
</li></ul></dd>
34713494

34723495

@@ -3632,7 +3655,7 @@ <h5>Parameters:</h5>
36323655

36333656
<dt class="tag-source">Source:</dt>
36343657
<dd class="tag-source"><ul class="dummy"><li>
3635-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line211">line 211</a>
3658+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line212">line 212</a>
36363659
</li></ul></dd>
36373660

36383661

@@ -3821,7 +3844,7 @@ <h5>Parameters:</h5>
38213844

38223845
<dt class="tag-source">Source:</dt>
38233846
<dd class="tag-source"><ul class="dummy"><li>
3824-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line246">line 246</a>
3847+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line247">line 247</a>
38253848
</li></ul></dd>
38263849

38273850

@@ -3962,7 +3985,7 @@ <h5>Parameters:</h5>
39623985

39633986
<dt class="tag-source">Source:</dt>
39643987
<dd class="tag-source"><ul class="dummy"><li>
3965-
<a href="index.js.html">index.js</a>, <a href="index.js.html#line369">line 369</a>
3988+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line370">line 370</a>
39663989
</li></ul></dd>
39673990

39683991

@@ -4014,7 +4037,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Mixpanel.
40144037
<br class="clear">
40154038

40164039
<footer>
4017-
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Wed Jan 26 2022 15:11:22 GMT-0800 (Pacific Standard Time)
4040+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Feb 25 2022 13:58:49 GMT-0800 (Pacific Standard Time)
40184041
</footer>
40194042

40204043
<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#line680">line 680</a>
98+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line681">line 681</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#line751">line 751</a>
287+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line752">line 752</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#line699">line 699</a>
449+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line700">line 700</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#line718">line 718</a>
609+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line719">line 719</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#line767">line 767</a>
771+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line768">line 768</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#line736">line 736</a>
908+
<a href="index.js.html">index.js</a>, <a href="index.js.html#line737">line 737</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 26 2022 15:11:22 GMT-0800 (Pacific Standard Time)
960+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Feb 25 2022 13:58:49 GMT-0800 (Pacific Standard Time)
961961
</footer>
962962

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

0 commit comments

Comments
 (0)