docs: update spectrum-ts documentation for v4.0.0#85
Closed
photon-action-bot[bot] wants to merge 1 commit into
Closed
docs: update spectrum-ts documentation for v4.0.0#85photon-action-bot[bot] wants to merge 1 commit into
photon-action-bot[bot] wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Superseded by #87 which targets a newer version. |
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
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.
Documentation Update: spectrum-ts v4.0.0
This PR updates documentation for spectrum-ts based on the v4.0.0 release.
Release Notes
Breaking Changes
Streaming Fusor now uses WebSockets instead of gRPC. If you customized the streaming endpoint, replace
SPECTRUM_FUSOR_GRPC_URL/endpointwithSPECTRUM_FUSOR_WS_URL/websocketEndpoint.Streaming mode now needs a runtime with a global
WebSocket, such as Bun, Node 22+, browsers, or edge workers. Webhook-only apps are not affected.New Features
app.messagesnow connects over Fusor’sfusor.v1.jsonWebSocket protocol, keeping the same message pipeline while making streaming easier to run outside gRPC-heavy environments. ✨The Fusor docs now include the WebSocket protocol details, including init frames, replies, heartbeats, close codes, auth, and reconnect behavior.
Improvement
Removed the gRPC client dependencies from
spectrum-ts, which makes the package lighter and avoids gRPC tooling for streaming users.The new stream client handles heartbeats, reconnect backoff, token refresh after auth failures, and only sends replies when Fusor asks for one.
Version: 4.0.0
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.