Skip to content

Commit 7c987e7

Browse files
committed
update docs on version
1 parent 35caef9 commit 7c987e7

File tree

7 files changed

+96
-7
lines changed

7 files changed

+96
-7
lines changed

amplitude.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1107,6 +1107,12 @@ Amplitude.prototype.setGlobalUserProperties = function setGlobalUserProperties(u
11071107
this.setUserProperties(userProperties);
11081108
};
11091109

1110+
/**
1111+
* Get the current version of Amplitude's Javascript SDK.
1112+
* @public
1113+
* @returns {number} version number
1114+
* @example var amplitudeVersion = amplitude.__VERSION__;
1115+
*/
11101116
Amplitude.prototype.__VERSION__ = version;
11111117

11121118
module.exports = Amplitude;

documentation/Amplitude.html

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,77 @@ <h5>Example</h5>
136136

137137

138138

139+
<h3 class="subsection-title">Members</h3>
140+
141+
142+
143+
<h4 class="name" id="__VERSION__"><span class="type-signature"></span>__VERSION__<span class="type-signature"></span></h4>
144+
145+
146+
147+
148+
<div class="description">
149+
Get the current version of Amplitude's Javascript SDK.
150+
</div>
151+
152+
153+
154+
155+
156+
157+
158+
<dl class="details">
159+
160+
161+
162+
163+
164+
165+
166+
167+
168+
169+
170+
171+
172+
173+
174+
175+
176+
177+
178+
179+
180+
181+
182+
183+
184+
185+
<dt class="tag-source">Source:</dt>
186+
<dd class="tag-source"><ul class="dummy"><li>
187+
<a href="amplitude.js.html">amplitude.js</a>, <a href="amplitude.js.html#line1010">line 1010</a>
188+
</li></ul></dd>
189+
190+
191+
192+
193+
194+
195+
196+
</dl>
197+
198+
199+
200+
201+
202+
<h5>Example</h5>
203+
204+
<pre class="prettyprint"><code>var amplitudeVersion = amplitude.__VERSION__;</code></pre>
205+
206+
207+
208+
209+
139210

140211

141212
<h3 class="subsection-title">Methods</h3>
@@ -2329,7 +2400,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
23292400
<br class="clear">
23302401

23312402
<footer>
2332-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:34:16 GMT-0700 (PDT)
2403+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:48:30 GMT-0700 (PDT)
23332404
</footer>
23342405

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

documentation/Identify.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1295,7 +1295,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
12951295
<br class="clear">
12961296

12971297
<footer>
1298-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:34:16 GMT-0700 (PDT)
1298+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:48:30 GMT-0700 (PDT)
12991299
</footer>
13001300

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

documentation/amplitude.js.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ <h1 class="page-title">Source: amplitude.js</h1>
110110

111111
// load deviceId and userId from input, or try to fetch existing value from cookie
112112
this.options.deviceId = (type(opt_config) === 'object' &amp;&amp; type(opt_config.deviceId) === 'string' &amp;&amp;
113-
!utils.isEmptyString(opt_config.deviceId) &amp;&amp; opt_config.deviceId) || this.options.deviceId || UUID();
113+
!utils.isEmptyString(opt_config.deviceId) &amp;&amp; opt_config.deviceId) || this.options.deviceId || UUID() + 'R';
114114
this.options.userId = (type(opt_userId) === 'string' &amp;&amp; !utils.isEmptyString(opt_userId) &amp;&amp; opt_userId) ||
115115
this.options.userId || null;
116116

@@ -490,7 +490,7 @@ <h1 class="page-title">Source: amplitude.js</h1>
490490
* @private
491491
*/
492492
Amplitude.prototype._getReferringDomain = function _getReferringDomain(referrer) {
493-
if (utils.isEmpty(referrer)) {
493+
if (utils.isEmptyString(referrer)) {
494494
return null;
495495
}
496496
var parts = referrer.split('/');
@@ -1029,6 +1029,12 @@ <h1 class="page-title">Source: amplitude.js</h1>
10291029
this.setUserProperties(userProperties);
10301030
};
10311031

1032+
/**
1033+
* Get the current version of Amplitude's Javascript SDK.
1034+
* @public
1035+
* @returns {number} version number
1036+
* @example var amplitudeVersion = amplitude.__VERSION__;
1037+
*/
10321038
Amplitude.prototype.__VERSION__ = version;
10331039

10341040
module.exports = Amplitude;
@@ -1048,7 +1054,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
10481054
<br class="clear">
10491055

10501056
<footer>
1051-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:34:16 GMT-0700 (PDT)
1057+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:48:30 GMT-0700 (PDT)
10521058
</footer>
10531059

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

documentation/identify.js.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
226226
<br class="clear">
227227

228228
<footer>
229-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:34:16 GMT-0700 (PDT)
229+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:48:30 GMT-0700 (PDT)
230230
</footer>
231231

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

documentation/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Amplitude
5656
<br class="clear">
5757

5858
<footer>
59-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:34:16 GMT-0700 (PDT)
59+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Fri Apr 01 2016 17:48:30 GMT-0700 (PDT)
6060
</footer>
6161

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

src/amplitude.js

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1001,6 +1001,12 @@ Amplitude.prototype.setGlobalUserProperties = function setGlobalUserProperties(u
10011001
this.setUserProperties(userProperties);
10021002
};
10031003

1004+
/**
1005+
* Get the current version of Amplitude's Javascript SDK.
1006+
* @public
1007+
* @returns {number} version number
1008+
* @example var amplitudeVersion = amplitude.__VERSION__;
1009+
*/
10041010
Amplitude.prototype.__VERSION__ = version;
10051011

10061012
module.exports = Amplitude;

0 commit comments

Comments
 (0)