chore: add documentation for anonymous id param

mongodb-js · Jun 1, 2023 · 7fa8ea4 · 7fa8ea4
1 parent 1560559
commit 7fa8ea4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -56,7 +56,7 @@
     "check": "npm run lint && npm run depcheck",
     "depcheck": "depcheck",
     "package": "npm list --production --parseable --depth=99999 --loglevel=info || true && vsce package --githubBranch main",
-    "local-install": "npm run package && code --install-extension ./mongodb-vscode-*.vsix",
+    "local-install": "npm run package && code --install-extension ./mongodb-vscode-*.vsix --force",
     "check-vsix-size": "ts-node ./scripts/check-vsix-size.ts",
     "release-draft": "node ./scripts/release-draft.js",
     "reformat": "prettier --write ."

diff --git a/src/utils/links.ts b/src/utils/links.ts
@@ -14,6 +14,9 @@ const LINKS = {
   github: 'https://github.com/mongodb-js/vscode',
   reportBug: 'https://github.com/mongodb-js/vscode/issues',
   atlas: 'https://www.mongodb.com/cloud/atlas',
+  /**
+   * @param anonymousId Segment analytics `anonymousId` (not `userId`) {@link https://segment.com/docs/connections/sources/catalog/libraries/website/javascript/querystring/}
+   */
   createAtlasCluster: (anonymousId: string) => {
     const ajsAid = anonymousId
       ? `?ajs_aid=${encodeURIComponent(anonymousId)}`