Skip to content

Add missing compresslevel parameter on docs #2553

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.

Sign up for GitHub

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
Kludex merged 2 commits into from
Mar 25, 2024
Merged

Add missing compresslevel parameter on docs #2553

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1ed171f
Add missing compresslevel parameter on docs
junah201 Mar 25, 2024
6db0582
Update docs/middleware.md
Kludex Mar 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/middleware.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ from starlette.middleware.gzip import GZipMiddleware
routes = ...

middleware = [
Middleware(GZipMiddleware, minimum_size=1000)
Middleware(GZipMiddleware, minimum_size=1000, compresslevel=9)
]

app = Starlette(routes=routes, middleware=middleware)
Expand All @@ -194,6 +194,7 @@ app = Starlette(routes=routes, middleware=middleware)
The following arguments are supported:

* `minimum_size` - Do not GZip responses that are smaller than this minimum size in bytes. Defaults to `500`.
* `compresslevel` - Used during GZip compression. It is an integer ranging from 1 to 9. Defaults to `9`. Lower value results in faster compression but larger file sizes, while higher value results in slower compression but smaller file sizes.

The middleware won't GZip responses that already have a `Content-Encoding` set, to prevent them from being encoded twice.

Expand Down