change parameter name to userAgentIdentifier

Author: fershad

src/hosting-api.js

@@ -5,29 +5,29 @@ import { getApiRequestHeaders } from "./helpers/index.js";
 /**
  * Check if a string or array of domains has been provided
  * @param {string|array} domain - The domain to check, or an array of domains to be checked.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  */
 
-function check(domain, comment) {
+function check(domain, userAgentIdentifier) {
   // is it a single domain or an array of them?
   if (typeof domain === "string") {
-    return checkAgainstAPI(domain, comment);
+    return checkAgainstAPI(domain, userAgentIdentifier);
   } else {
-    return checkDomainsAgainstAPI(domain, comment);
+    return checkDomainsAgainstAPI(domain, userAgentIdentifier);
   }
 }
 
 /**
  * Check if a domain is hosted by a green web host by querying the Green Web Foundation API.
  * @param {string} domain - The domain to check.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.
  */
-async function checkAgainstAPI(domain, comment) {
+async function checkAgainstAPI(domain, userAgentIdentifier) {
   const req = await fetch(
     `https://api.thegreenwebfoundation.org/greencheck/${domain}`,
     {
-      headers: getApiRequestHeaders(comment),
+      headers: getApiRequestHeaders(userAgentIdentifier),
     }
   );
   const res = await req.json();
@@ -37,17 +37,17 @@ async function checkAgainstAPI(domain, comment) {
 /**
  * Check if an array of domains is hosted by a green web host by querying the Green Web Foundation API.
  * @param {array} domains - An array of domains to check.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @returns {array} - An array of domains that are hosted by a green web host.
  */
 
-async function checkDomainsAgainstAPI(domains, comment) {
+async function checkDomainsAgainstAPI(domains, userAgentIdentifier) {
   try {
     const apiPath = "https://api.thegreenwebfoundation.org/v2/greencheckmulti";
     const domainsString = JSON.stringify(domains);
 
     const req = await fetch(`${apiPath}/${domainsString}`, {
-      headers: getApiRequestHeaders(comment),
+      headers: getApiRequestHeaders(userAgentIdentifier),
     });
 
     const allGreenCheckResults = await req.json();

src/hosting-node.js

@@ -18,15 +18,15 @@ import { getApiRequestHeaders } from "./helpers/index.js";
  * for parsing as JSON.
  *
  * @param {string} url
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @return {string}
  */
-async function getBody(url, comment) {
+async function getBody(url, userAgentIdentifier) {
   return new Promise(function (resolve, reject) {
     // Do async job
     const req = https.get(
       url,
-      { headers: getApiRequestHeaders(comment) },
+      { headers: getApiRequestHeaders(userAgentIdentifier) },
       function (res) {
         if (res.statusCode < 200 || res.statusCode >= 300) {
           return reject(
@@ -52,34 +52,34 @@ async function getBody(url, comment) {
  * Check if a domain is hosted by a green web host.
  * @param {string|array} domain - The domain to check, or an array of domains to be checked.
  * @param {object} db - Optional. A database object to use for lookups.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @returns {boolean|array} - A boolean if a string was provided, or an array of booleans if an array of domains was provided.
  */
 
-function check(domain, db, comment) {
+function check(domain, db, userAgentIdentifier) {
   if (db) {
     return hostingJSON.check(domain, db);
   }
 
   // is it a single domain or an array of them?
   if (typeof domain === "string") {
-    return checkAgainstAPI(domain, comment);
+    return checkAgainstAPI(domain, userAgentIdentifier);
   } else {
-    return checkDomainsAgainstAPI(domain, comment);
+    return checkDomainsAgainstAPI(domain, userAgentIdentifier);
   }
 }
 
 /**
  * Check if a domain is hosted by a green web host by querying the Green Web Foundation API.
  * @param {string} domain - The domain to check.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @returns {boolean} - A boolean indicating whether the domain is hosted by a green web host.
  */
-async function checkAgainstAPI(domain, comment) {
+async function checkAgainstAPI(domain, userAgentIdentifier) {
   const res = JSON.parse(
     await getBody(
       `https://api.thegreenwebfoundation.org/greencheck/${domain}`,
-      comment
+      userAgentIdentifier
     )
   );
   return res.green;
@@ -88,17 +88,17 @@ async function checkAgainstAPI(domain, comment) {
 /**
  * Check if an array of domains is hosted by a green web host by querying the Green Web Foundation API.
  * @param {array} domains - An array of domains to check.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @returns {array} - An array of domains that are hosted by a green web host.
  */
-async function checkDomainsAgainstAPI(domains, comment) {
+async function checkDomainsAgainstAPI(domains, userAgentIdentifier) {
   try {
     const allGreenCheckResults = JSON.parse(
       await getBody(
         `https://api.thegreenwebfoundation.org/v2/greencheckmulti/${JSON.stringify(
           domains
         )}`,
-        comment
+        userAgentIdentifier
       )
     );
     return hostingJSON.greenDomainsFromResults(allGreenCheckResults);

src/hosting.js

@@ -5,11 +5,11 @@ import hostingAPI from "./hosting-api.js";
 /**
  * Check if a domain is hosted by a green web host.
  * @param {string|array} domain - The domain to check, or an array of domains to be checked.
- * @param {string} comment - Optional. The app, site, or organisation that is making the request.
+ * @param {string} userAgentIdentifier - Optional. The app, site, or organisation that is making the request.
  * @returns {boolean|array} - A boolean if a string was provided, or an array of booleans if an array of domains was provided.
  */
-function check(domain, comment) {
-  return hostingAPI.check(domain, comment);
+function check(domain, userAgentIdentifier) {
+  return hostingAPI.check(domain, userAgentIdentifier);
 }
 
 export default {