Feature - Google Analytics - Added JSDoc to Google Analytics functions.

This commit is contained in:
c 2023-01-12 00:02:11 +00:00
parent 2b3a3895b3
commit fb2999706c

View File

@ -1,8 +1,22 @@
let GoogleAnalytics = (() => { let GoogleAnalytics = (() => {
/**
* Returns a string that represents the javascript that is required to insert the Google Analytics scripts
* into a webpage.
* @param tagId Google UA/G/AW/DC Property ID to use with the Google Analytics script.
* @returns {string}
*/
function getGoogleAnalyticsScript(tagId) { function getGoogleAnalyticsScript(tagId) {
return "<script async src=\"https://www.googletagmanager.com/gtag/js?id=" + tagId + "\"></script>" + return "<script async src=\"https://www.googletagmanager.com/gtag/js?id=" + tagId + "\"></script>" +
"<script>window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date());gtag('config', '" + tagId + "'); </script>"; "<script>window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date());gtag('config', '" + tagId + "'); </script>";
} }
/**
* Returns true if the tag conforms to the format of 1-2 Letters followed by a dash and 8 numbers.
* This should take care of the following property tag formats:
* UA-########, G-########, AW-########, DC-########
* @param {String} tagInput Google UA/G/AW/DC Property ID
* @returns {boolean}
*/
function isValidTag(tagInput) { function isValidTag(tagInput) {
const re = /^\w{1,2}-\d{8}$/g; const re = /^\w{1,2}-\d{8}$/g;
return tagInput.match(re) != null; return tagInput.match(re) != null;