Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@zihejia
zihejia committed Dec 2, 2023
1 parent 6a4a91a commit 8e1e815
Show file tree
Hide file tree
Showing 5 changed files with 198 additions and 46 deletions.
189 changes: 164 additions & 25 deletions docs/Mixpanel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -469,7 +469,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line322">line 322</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line335">line 335</a>
</li></ul></dd>


Expand Down Expand Up @@ -636,7 +636,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line223">line 223</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line236">line 236</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line430">line 430</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line443">line 443</a>
</li></ul></dd>


Expand Down Expand Up @@ -891,7 +891,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line350">line 350</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line363">line 363</a>
</li></ul></dd>


Expand Down Expand Up @@ -1028,7 +1028,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line455">line 455</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line468">line 468</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line515">line 515</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line528">line 528</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line502">line 502</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line515">line 515</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line484">line 484</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line497">line 497</a>
</li></ul></dd>


Expand Down Expand Up @@ -1541,7 +1541,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line312">line 312</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line325">line 325</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line262">line 262</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line275">line 275</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line418">line 418</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line431">line 431</a>
</li></ul></dd>


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

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line149">line 149</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line162">line 162</a>
</li></ul></dd>


Expand Down Expand Up @@ -2036,7 +2036,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line194">line 194</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line207">line 207</a>
</li></ul></dd>


Expand Down Expand Up @@ -2348,7 +2348,7 @@ <h4 class="name" id="optInTracking"><span class="type-signature"></span>optInTra

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line159">line 159</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line172">line 172</a>
</li></ul></dd>


Expand Down Expand Up @@ -2440,7 +2440,7 @@ <h4 class="name" id="optOutTracking"><span class="type-signature"></span>optOutT

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line170">line 170</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line183">line 183</a>
</li></ul></dd>


Expand Down Expand Up @@ -2587,7 +2587,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line372">line 372</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line385">line 385</a>
</li></ul></dd>


Expand Down Expand Up @@ -2727,7 +2727,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line387">line 387</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line400">line 400</a>
</li></ul></dd>


Expand Down Expand Up @@ -2887,7 +2887,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line335">line 335</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line348">line 348</a>
</li></ul></dd>


Expand Down Expand Up @@ -2976,7 +2976,146 @@ <h4 class="name" id="reset"><span class="type-signature"></span>reset<span class

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line466">line 466</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line479">line 479</a>
</li></ul></dd>







</dl>


























<h4 class="name" id="setFlushBatchSize"><span class="type-signature"></span>setFlushBatchSize<span class="signature">(flushBatchSize)</span><span class="type-signature"></span></h4>






<div class="description">
Set the number of events sent in a single network request to the Mixpanel server.
By configuring this value, you can optimize network usage and manage the frequency of communication between the client and the server. The maximum size is 50; any value over 50 will default to 50.
</div>









<h5>Parameters:</h5>


<table class="params">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>flushBatchSize</code></td>


<td class="type">


<span class="param-type">integer</span>



</td>





<td class="description last">whether to automatically send the client IP Address.
Defaults to true.</td>
</tr>


</tbody>
</table>






<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a>
</li></ul></dd>


Expand Down Expand Up @@ -3274,7 +3413,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line296">line 296</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line309">line 309</a>
</li></ul></dd>


Expand Down Expand Up @@ -3831,7 +3970,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line441">line 441</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line454">line 454</a>
</li></ul></dd>


Expand Down Expand Up @@ -3997,7 +4136,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line245">line 245</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line258">line 258</a>
</li></ul></dd>


Expand Down Expand Up @@ -4186,7 +4325,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line280">line 280</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line293">line 293</a>
</li></ul></dd>


Expand Down Expand Up @@ -4327,7 +4466,7 @@ <h5>Parameters:</h5>

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line403">line 403</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line416">line 416</a>
</li></ul></dd>


Expand Down Expand Up @@ -4379,7 +4518,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Mixpanel.
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Tue Jun 20 2023 11:54:12 GMT-0700 (Pacific Daylight Time)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.6</a> on Fri Dec 01 2023 16:27:57 GMT-0800 (Pacific Standard Time)
</footer>

<script> prettyPrint(); </script>
Expand Down
Loading

0 comments on commit 8e1e815

Please sign in to comment.