Skip to content

chore(analytics): document that screenName must be non-empty in trackScreenView/trackScreenLeave - #446

Merged
rahul-mixpanel merged 3 commits into
masterfrom
rahulraveendran-sdk-142-document-that-screenname-is-mandatory-in
Jul 29, 2026
Merged

chore(analytics): document that screenName must be non-empty in trackScreenView/trackScreenLeave#446
rahul-mixpanel merged 3 commits into
masterfrom
rahulraveendran-sdk-142-document-that-screenname-is-mandatory-in

Conversation

@rahul-mixpanel

Copy link
Copy Markdown
Contributor

Summary

  • Update JSDoc on screenName param for trackScreenView and trackScreenLeave in index.js stating it must be non-empty and the event is silently dropped if empty/whitespace-only.
  • Add JSDoc to TypeScript definitions in index.d.ts for the same methods.
  • Run prettier on changed files.

Test plan

  • Verify JSDoc renders correctly in IDE hover tooltips

SDK-142

@rahul-mixpanel
rahul-mixpanel requested review from a team and tylerjroach July 28, 2026 17:44
@linear-code

linear-code Bot commented Jul 28, 2026

Copy link
Copy Markdown

SDK-142

@greptile-apps

greptile-apps Bot commented Jul 28, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
index.js Adds documentation for the existing screen-name validation behavior.
index.d.ts Adds matching API documentation to the TypeScript declarations.

Reviews (2): Last reviewed commit: "Revert "chore: run prettier on index.js ..." | Re-trigger Greptile

tylerjroach
tylerjroach previously approved these changes Jul 28, 2026
@rahul-mixpanel rahul-mixpanel self-assigned this Jul 29, 2026
@rahul-mixpanel
rahul-mixpanel merged commit 2876bde into master Jul 29, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants