📝 Add docstrings to claude/issue-27-20250629_142659

Docstrings generation was requested by @jaspermayone.

* #112 (comment)

The following files were modified:

* `src/func/domain/domain.ts`
* `src/func/domain/parseData.ts`

Author: coderabbitai[bot]

src/func/domain/domain.ts

@@ -18,11 +18,14 @@ import { db } from "src/utils/db";
 import { warn } from "src/utils/logger";
 
 /**
- * Helper function to safely call an external API service with quota error handling
- * @param serviceName - Name of the service for logging
- * @param serviceCall - Promise function to call the service
- * @param domain - Domain being checked (for logging)
- * @returns Service response or null if failed
+ * Executes an external service call for a domain, returning the result or `null` if an error occurs.
+ *
+ * Handles quota and rate limit errors gracefully by logging a warning and skipping the service check, allowing the overall process to continue without interruption.
+ *
+ * @param serviceName - The name of the external service being called, used for logging context.
+ * @param serviceCall - A function that returns a Promise for the external service request.
+ * @param domain - The domain being checked, included in log messages for context.
+ * @returns The service response if successful, or `null` if an error or quota limit is encountered.
  */
 async function safeServiceCall(
   serviceName: string,
@@ -57,9 +60,12 @@ async function safeServiceCall(
 }
 
 /**
- * Check the domain against all the services
- * @param domain - Domain to check
- * @returns void
+ * Performs security and reputation checks on a domain using multiple external services.
+ *
+ * Calls a set of external services to assess the given domain, handling errors gracefully for each service. Ensures the domain is recorded in the database if not already present.
+ *
+ * @param domain - The domain name to check
+ * @returns An object containing the results from each service, with `null` for any service that failed or was rate-limited
  */
 export async function domainCheck(domain: string) {
   const tsStart = Date.now();

src/func/domain/parseData.ts

@@ -1,17 +1,10 @@
 /**
- * parses the data from the different sources and returns a boolean value
- * @param walshyData - Data from Walshy API
- * @param ipQualityScoreData - Data from IPQualityScore API
- * @param googleSafebrowsingData - Data from Google Safebrowsing API
- * @param sinkingYahtsData - Data from Sinking Yahts API
- * @param virusTotalData - Data from VirusTotal API
- * @param phishObserverData - Data from PhishObserver API
- * @param urlScanData - Data from URLScan API
- * @param securitytrailsData - Data from SecurityTrails API
- * @param phishreportData - Data from Phishreport API
- * @param abuseChData - Data from AbuseCh API
- * @returns boolean
- **/
+ * Aggregates results from multiple security data sources to determine if a domain is malicious or unsafe.
+ *
+ * Evaluates input from various APIs and returns `true` if any source indicates the domain is potentially harmful; otherwise, returns `false`.
+ *
+ * @returns `true` if any data source flags the domain as malicious or unsafe; otherwise, `false`.
+ */
 export async function parseData(
   walshyData: any,
   ipQualityScoreData: any,