Skip to content
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.

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

fix some typos in optimize-storage.md #1565

Merged
merged 3 commits into from
Sep 13, 2024

Conversation

riadhmouamnia
Copy link
Contributor

I just noticed some typos while I was learning this lib:

  1. I think the writer of this doc meant to say "kind of mouse interactions" not "kins of..." in:
sampling: {
    // Configure which kins of mouse interaction should be recorded
    mouseInteraction: {
  1. The imported pack and unpack functions should be used instead of rrweb.pack and rrweb.unpack
// Recorder side
import { pack } from '@rrweb/packer';

rrweb.record({
  emit(event) {},
  packFn: rrweb.pack,
});

// Replayer Side
import { unpack } from '@rrweb/packer';

const replayer = new rrweb.Replayer(events, {
  unpackFn: rrweb.unpack,
});

Copy link

changeset-bot bot commented Sep 10, 2024

🦋 Changeset detected

Latest commit: a2a579a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@@ -49,7 +49,7 @@ rrweb.record({
rrweb.record({
emit(event) {},
sampling: {
// Configure which kins of mouse interaction should be recorded
// Configure which kind of mouse interactions should be recorded
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Configure which kind of mouse interactions should be recorded
// Configure which kinds of mouse interaction should be recorded

@Juice10
Copy link
Contributor

Juice10 commented Sep 13, 2024

Thank you @riadhmouamnia!

@YunFeng0817 YunFeng0817 merged commit 61ab209 into rrweb-io:master Sep 13, 2024
6 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.

4 participants