Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rahul-mixpanel merged 3 commits into from
Jul 29, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1f43b52
docs: document that screenName must be non-empty in trackScreenView/t…
rahul-mixpanel Jul 28, 2026
ee73af6
chore: run prettier on index.js and index.d.ts
rahul-mixpanel Jul 28, 2026
dc6cf4a
Revert "chore: run prettier on index.js and index.d.ts"
rahul-mixpanel Jul 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,21 @@ export interface Flags {
}

export class Autocapture {
/**
* Track a screen view event.
*
* @param screenName The name of the screen being viewed. Must be non-empty;
* if an empty or whitespace-only string is passed, the event is silently dropped.
* @param properties Optional additional properties to include with the event
*/
trackScreenView(screenName: string, properties?: MixpanelProperties): void;
/**
* Track a screen leave event.
*
* @param screenName The name of the screen being left. Must be non-empty;
* if an empty or whitespace-only string is passed, the event is silently dropped.
* @param properties Optional additional properties to include with the event
*/
trackScreenLeave(screenName: string, properties?: MixpanelProperties): void;
}

Expand Down
6 changes: 4 additions & 2 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -726,7 +726,8 @@ export class Autocapture {
/**
* Track a screen view event.
*
* @param {string} screenName The name of the screen being viewed
* @param {string} screenName The name of the screen being viewed. Must be non-empty;
* if an empty or whitespace-only string is passed, the event is silently dropped.
* @param {object} properties Optional additional properties to include with the event
*/
trackScreenView(screenName, properties) {
Expand All @@ -750,7 +751,8 @@ export class Autocapture {
/**
* Track a screen leave event.
*
* @param {string} screenName The name of the screen being left
* @param {string} screenName The name of the screen being left. Must be non-empty;
* if an empty or whitespace-only string is passed, the event is silently dropped.
* @param {object} properties Optional additional properties to include with the event
*/
trackScreenLeave(screenName, properties) {
Expand Down
Loading