Fix protocols type in PartySocketOptions to accept ProtocolsProvider#372
Merged
Conversation
The `protocols` field was typed as `string[]` but the underlying ReconnectingWebSocket already supports the full ProtocolsProvider type (null, string, string[], sync/async functions). This widens the public type to match the runtime capability. Fixes #371 Made-with: Cursor
🦋 Changeset detectedLatest commit: 10cf44a The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
hono-party
partyfn
partyserver
partysocket
partysub
partysync
partytracks
partywhen
y-partyserver
commit: |
Regenerate package-lock.json to update and normalize inconsistent "peer": true entries across dependency records. This is a lockfile-only change produced by the package manager; no source code was modified.
Made-with: Cursor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PartySocketOptions.protocolsfromstring[]toProtocolsProvider, matching the type already accepted by the underlyingReconnectingWebSocketconstructor.null, a singlestring, astring[], a sync function, or an async function — all of which the runtime already supports.Fixes #371
Test plan
npm run check:type)ProtocolsProvidervariants at theReconnectingWebSocketlevel (seereconnecting.test.ts— "websocket sync protocolsProvider", "websocket async protocolsProvider")usePartySockethook inherits its type fromPartySocketOptions, so it also benefits from this fix automaticallyMade with Cursor