fix(vite-plugin-nitro): enable websocket support & add docs #1419
+130
−4
Conversation
This file contains 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
✅ Deploy Preview for analog-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-app ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for analog-ng-app ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nckirik
changed the title
nckirik
changed the title
✅ Deploy Preview for analog-blog ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
brandonroberts
requested changes
Oct 25, 2024
|
|
||
| ## Enable WebSockets | ||
|
|
||
| Currently, WebSocket support in [Nitro](https://nitro.unjs.io/guide/websocket) is experimental and it should be enabled: |
There was a problem hiding this comment.
Suggested change
| Currently, WebSocket support in [Nitro](https://nitro.unjs.io/guide/websocket) is experimental and it should be enabled: | |
| Currently, WebSocket support in [Nitro](https://nitro.unjs.io/guide/websocket) is experimental and it can be enabled in the `analog` plugin: |
|
|
||
| ### WebSocket Routes | ||
|
|
||
| Due to technical limitations in the Analog-Nitro integration, WebSocket routes are exposed without the `/api` prefix. |
There was a problem hiding this comment.
Suggested change
| Due to technical limitations in the Analog-Nitro integration, WebSocket routes are exposed without the `/api` prefix. | |
| Analog's internal API middleware is not applied to WebSocket routes, therefore, WebSocket routes are exposed without the `/api` prefix. |
|
|
||
| Due to technical limitations in the Analog-Nitro integration, WebSocket routes are exposed without the `/api` prefix. | ||
|
|
||
| For example, `src/server/routes/ws/chat.ts` will be exposed as `ws://example.com/ws/chat` instead of `ws://example.com/api/ws/chat` |
There was a problem hiding this comment.
Suggested change
| For example, `src/server/routes/ws/chat.ts` will be exposed as `ws://example.com/ws/chat` instead of `ws://example.com/api/ws/chat` | |
| For example, `src/server/routes/ws/chat.ts` is exposed as `ws://example.com/ws/chat` instead of `ws://example.com/api/ws/chat` |
|
|
||
| Analog also supports `WebSockets` and `Server-Sent Events` through Nitro. | ||
|
|
||
| ## Enable WebSockets |
There was a problem hiding this comment.
Suggested change
| ## Enable WebSockets | |
| ## Enabling WebSockets |
brandonroberts
changed the title
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.
PR Checklist
Closes #1398
What is the new behavior?
Does this PR introduce a breaking change?
Other information
[optional] What gif best describes this PR or how it makes you feel?