comments

Author: EspressoTrip-v2

src/bin/mongoReplicas.ts

@@ -1,5 +1,13 @@
 #!/usr/bin/env node
 import { resolveSrv } from 'dns/promises';
+
+/**
+ * NPX script to resolve MongoDB SRV records.
+ * @example npx @journeyapps/https-proxy-socket mongo-replicas mongodb+srv://<username>:<password>@cluster1.vlnzcbp.mongodb.net
+ * @example npx @journeyapps/https-proxy-socket mongo-replicas mongodb+srv://cluster1.vlnzcbp.mongodb.net
+ *
+ * @returns An object with a `replicas` property containing the resolved host:port pairs.
+ */
 async function mongoReplicas() {
   const srvUrl = process.argv[3];
   const url = new URL(srvUrl);