feat(useEventSource): add `serializer` #4953

imddc · 2025-08-10T12:23:53Z

Before submitting the PR, please make sure you do the following

Read the Contributing Guidelines.
Read the Pull Request Guidelines.
Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
Ideally, include relevant tests that fail without this PR but pass with it.

⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.

Description

JSON Parsing: Automatically parse JSON strings from EventSource into JavaScript objects
Custom Transformations: Apply user-defined transformation functions to incoming data
Backward Compatibility: All existing functionality remains unchanged, serialization is opt-in

Additional context

This enhancement addresses a common pain point when working with EventSource APIs that send JSON data as strings, requiring manual parsing in every usage. The implementation follows VueUse's existing patterns and maintains full backward compatibility.

packages/core/useEventSource/index.ts

OrbisK · 2025-08-10T12:59:40Z

Thank you for your PR.

OrbisK

Looks good so far. Some small adjustments.

Maybe we should rename it to: serializer like useBase64

packages/core/useEventSource/index.ts

imddc · 2025-08-11T08:14:10Z

Looks good so far. Some small adjustments.

Maybe we should rename it to: serializer like useBase64

Thank you！
I have adopted your suggestion, and it looks much better!

OrbisK · 2025-08-11T08:39:26Z

There are no new commits. Maybe you forgot to push 😅

imddc · 2025-08-12T00:47:03Z

There are no new commits. Maybe you forgot to push 😅

I forgot last time. Could you please do the code review again?

packages/core/useEventSource/index.ts

imddc · 2025-08-12T07:19:17Z

how about now?

packages/core/useEventSource/index.ts

OrbisK

lgtm!

Thank you!

packages/core/useEventSource/index.md

…he other composables

packages/core/useEventSource/index.ts

pkg-pr-new · 2025-08-15T14:59:49Z

Open in StackBlitz

@vueuse/components

npm i https://pkg.pr.new/@vueuse/components@4953

@vueuse/core

npm i https://pkg.pr.new/@vueuse/core@4953

@vueuse/electron

npm i https://pkg.pr.new/@vueuse/electron@4953

@vueuse/firebase

npm i https://pkg.pr.new/@vueuse/firebase@4953

@vueuse/integrations

npm i https://pkg.pr.new/@vueuse/integrations@4953

@vueuse/math

npm i https://pkg.pr.new/@vueuse/math@4953

@vueuse/metadata

npm i https://pkg.pr.new/@vueuse/metadata@4953

@vueuse/nuxt

npm i https://pkg.pr.new/@vueuse/nuxt@4953

@vueuse/router

npm i https://pkg.pr.new/@vueuse/router@4953

@vueuse/rxjs

npm i https://pkg.pr.new/@vueuse/rxjs@4953

@vueuse/shared

npm i https://pkg.pr.new/@vueuse/shared@4953

commit: 64629e8

43081j · 2025-08-18T09:03:40Z

this looks good, but its actually deserialising, right?

it is taking the data from the event and deserialising it. afaik, event source data is always a string and its upto the consumer to deserialise it

if this is the case, we should probably either call it deserializer or we should follow the structure useStorage has (serializer: {read, write}) - but just not use the write part

@OrbisK thoughts?

OrbisK · 2025-08-18T09:21:58Z

this looks good, but its actually deserialising, right?

Yeah, you're right.

if this is the case, we should probably either call it deserializer or we should follow the structure useStorage has (serializer: {read, write}) - but just not use the write part

I like the idea of having only the read part. If we use this approach, we should update useBase64 to only include the write part (v14).

43081j · 2025-08-18T09:56:01Z

👍 that works for me, these 3 functions can share roughly the same serialisation type then, which would be nice

OrbisK · 2025-08-18T11:30:01Z

@imddc would you mind changing this one more time? 😅

imddc · 2025-08-18T12:59:25Z

@imddc would you mind changing this one more time? 😅

I have modified the code. Please review it again

imddc added 3 commits August 10, 2025 20:14

feat(useEventSource): add serialization options for data processing

3487bf8

test(useEventSource): add tests for serialization functionality

c0696aa

docs(useEventSource): add documentation for serialization feature

644c6a4

dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Aug 10, 2025

OrbisK requested changes Aug 10, 2025

View reviewed changes

packages/core/useEventSource/index.ts Outdated Show resolved Hide resolved

refactor(useEventSource): use another way to use seriallization

81b5656

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Aug 10, 2025

imddc changed the title ~~Feat/enhance useEventSource~~ feat(useEventSource): add transformer Aug 11, 2025

OrbisK requested changes Aug 11, 2025

View reviewed changes

imddc requested a review from OrbisK August 11, 2025 08:14

feat(useEventSource): rename to serilazation

d80ca06

OrbisK requested changes Aug 12, 2025

View reviewed changes

packages/core/useEventSource/index.ts Outdated Show resolved Hide resolved

packages/core/useEventSource/index.ts Outdated Show resolved Hide resolved

packages/core/useEventSource/index.ts Outdated Show resolved Hide resolved

fix(useEventSource): fix type

6b603a8

OrbisK requested changes Aug 12, 2025

View reviewed changes

packages/core/useEventSource/index.ts Outdated Show resolved Hide resolved

fix(useEventSource): complete the missing types

f115644

imddc requested a review from OrbisK August 12, 2025 08:14

OrbisK approved these changes Aug 12, 2025

View reviewed changes

OrbisK requested review from 43081j and ilyaliao August 12, 2025 08:17

dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 12, 2025

OrbisK requested changes Aug 13, 2025

View reviewed changes

packages/core/useEventSource/index.md Outdated Show resolved Hide resolved

dosubot bot removed the lgtm This PR has been approved by a maintainer label Aug 13, 2025

[autofix.ci] apply automated fixes

d45fbf0

imddc requested a review from OrbisK August 14, 2025 13:34

docs: rename serialization to serializer to ensure consistency with t…

996408e

…he other composables

OrbisK reviewed Aug 14, 2025

View reviewed changes

packages/core/useEventSource/index.ts Outdated Show resolved Hide resolved

chore(useEventSource): rename serialization to serialize in other file

a8012d4

OrbisK previously approved these changes Aug 18, 2025

View reviewed changes

dosubot bot added the lgtm This PR has been approved by a maintainer label Aug 18, 2025

imddc added 2 commits August 18, 2025 20:10

refactor(useEventSource): adjust API style to match existing patterns

4b9211e

fix(useEventSource): fix types and tests

b99d83a

imddc dismissed OrbisK’s stale review via b99d83a August 18, 2025 12:46

OrbisK approved these changes Aug 18, 2025

View reviewed changes

OrbisK mentioned this pull request Aug 20, 2025

fix(useEventSource): replace wrong Data generic with string #4974

Closed

5 tasks

Merge branch 'main' into feat/enhance-useEventSource

64629e8

ilyaliao approved these changes Aug 20, 2025

View reviewed changes

43081j approved these changes Aug 20, 2025

View reviewed changes

OrbisK changed the title ~~feat(useEventSource): add transformer~~ feat(useEventSource): add serializer Aug 21, 2025

OrbisK added this pull request to the merge queue Aug 21, 2025

Merged via the queue into vueuse:main with commit 64651a3 Aug 21, 2025
10 checks passed

Uh oh!

feat(useEventSource): add serializer #4953

feat(useEventSource): add serializer #4953

Uh oh!

Conversation

imddc commented Aug 10, 2025

Before submitting the PR, please make sure you do the following

Description

Additional context

Uh oh!

Uh oh!

OrbisK commented Aug 10, 2025

Uh oh!

OrbisK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imddc commented Aug 11, 2025

Uh oh!

OrbisK commented Aug 11, 2025

Uh oh!

imddc commented Aug 12, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

imddc commented Aug 12, 2025

Uh oh!

Uh oh!

OrbisK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pkg-pr-new bot commented Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

43081j commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OrbisK commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

43081j commented Aug 18, 2025

Uh oh!

OrbisK commented Aug 18, 2025

Uh oh!

imddc commented Aug 18, 2025

Uh oh!

Uh oh!

Uh oh!

feat(useEventSource): add `serializer` #4953

feat(useEventSource): add `serializer` #4953

pkg-pr-new bot commented Aug 15, 2025 •

edited

Loading

43081j commented Aug 18, 2025 •

edited

Loading

OrbisK commented Aug 18, 2025 •

edited

Loading