-
-
Notifications
You must be signed in to change notification settings - Fork 146
feat(server): Compression Plugin #869
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
47f2935
CompressionPlugin - node adapter
dinwwwh f7b103a
improve
dinwwwh f7ed7a6
docs
dinwwwh 77ff182
fetch adapter
dinwwwh e2df4d7
improve
dinwwwh 5de7178
Update apps/content/docs/plugins/compression.md
dinwwwh 6954900
improve
dinwwwh 0f760c0
improve
dinwwwh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| title: Compression Plugin | ||
| description: A plugin for oRPC that compresses response bodies. | ||
| --- | ||
|
|
||
| # Compression Plugin | ||
|
|
||
| The **Compression Plugin** compresses response bodies to reduce bandwidth usage and improve performance. | ||
|
|
||
| ## Import | ||
|
|
||
| Depending on your adapter, import the corresponding plugin: | ||
|
|
||
| ```ts | ||
| import { CompressionPlugin } from '@orpc/server/node' | ||
| import { CompressionPlugin } from '@orpc/server/fetch' | ||
| ``` | ||
|
|
||
| ## Setup | ||
|
|
||
| Add the plugin to your handler configuration: | ||
|
|
||
| ```ts | ||
| const handler = new RPCHandler(router, { | ||
| plugins: [ | ||
| new CompressionPlugin(), | ||
| ], | ||
| }) | ||
| ``` | ||
|
|
||
| ::: info | ||
| The `handler` can be any supported oRPC handler, such as [RPCHandler](/docs/rpc-handler), [OpenAPIHandler](/docs/openapi/openapi-handler), or another custom handler. | ||
| ::: | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| import { defineBuildConfig } from 'unbuild' | ||
|
|
||
| export default defineBuildConfig({ | ||
| /** | ||
| * Disable warnings as errors because we need to inline the `compression` package, | ||
| * which is not ESModule-friendly. | ||
| */ | ||
| failOnWarn: false, | ||
| }) |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.