Skip to content

ref(replay): Add jsdoc to all replay modules #6654

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

Jump to bottom
Merged
merged 1 commit into from
Jan 9, 2023
Merged

ref(replay): Add jsdoc to all replay modules #6654

merged 1 commit into from
Jan 9, 2023

Conversation

mydea
Copy link
Member

@mydea mydea commented Jan 4, 2023

This is one more step of #6323.

Note that this also renames/moves a few things to make more sense:

  • rename createPayload() to createRecordingData()
  • rename getReplayEvent() to prepareReplayEvent()
  • move ReplayPerformanceEntry type to types.ts
  • move createMemoryEntry to addMemoryEntry.ts, as that was actually the only place where this was used

@mydea mydea added the Package: replay Issues related to the Sentry Replay SDK label Jan 4, 2023
@mydea mydea requested review from billyvg and Lms24 January 4, 2023 13:25
@mydea mydea self-assigned this Jan 4, 2023
@mydea mydea mentioned this pull request Jan 4, 2023
Closed
6 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Jan 4, 2023 •
edited
Loading

size-limit report 📦

Path Size
@sentry/browser - ES5 CDN Bundle (gzipped + minified) 19.84 KB (0%)
@sentry/browser - ES5 CDN Bundle (minified) 61.46 KB (+0.03% 🔺)
@sentry/browser - ES6 CDN Bundle (gzipped + minified) 18.62 KB (+0.02% 🔺)
@sentry/browser - ES6 CDN Bundle (minified) 55 KB (+0.02% 🔺)
@sentry/browser - Webpack (gzipped + minified) 20.38 KB (-0.05% 🔽)
@sentry/browser - Webpack (minified) 66.55 KB (-0.14% 🔽)
@sentry/react - Webpack (gzipped + minified) 20.4 KB (-0.03% 🔽)
@sentry/nextjs Client - Webpack (gzipped + minified) 47.67 KB (-0.03% 🔽)
@sentry/browser + @sentry/tracing - ES5 CDN Bundle (gzipped + minified) 26.82 KB (+0.03% 🔺)
@sentry/browser + @sentry/tracing - ES6 CDN Bundle (gzipped + minified) 25.25 KB (0%)
@sentry/replay ES6 CDN Bundle (gzipped + minified) 43.06 KB (+0.16% 🔺)
@sentry/replay - Webpack (gzipped + minified) 38.3 KB (+0.17% 🔺)

billyvg
billyvg approved these changes Jan 4, 2023
View reviewed changes
@mydea mydea force-pushed the fn/replay-jsdoc branch 2 times, most recently from bdccf32 to 7e499a1 Compare January 5, 2023 08:21
Lms24
Lms24 approved these changes Jan 5, 2023
View reviewed changes
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work!

packages/replay/.eslintrc.js
Comment on lines +28 to 29
// Since we target only es6 here, we can leave this off
'@sentry-internal/sdk/no-async-await': 'off',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point!

@mydea mydea force-pushed the fn/replay-jsdoc branch 3 times, most recently from 21b44ed to 72dfa77 Compare January 9, 2023 08:23
@mydea
ref(replay): Add jsdoc to all replay modules
3bca660 
This is one more step of #6323.

Note that this also renames/moves a few things to make more sense.
@mydea mydea merged commit 1b4d9da into master Jan 9, 2023
@mydea mydea deleted the fn/replay-jsdoc branch January 9, 2023 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@billyvg billyvg billyvg approved these changes

@Lms24 Lms24 Lms24 approved these changes

Assignees

@mydea mydea

Labels
Package: replay Issues related to the Sentry Replay SDK
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mydea @billyvg @Lms24