Skip to content

Commit

Permalink
Add missing compresslevel parameter on docs (#2553)
Browse files Browse the repository at this point in the history
* Add missing compresslevel parameter on docs

The compresslevel parameter was added in #1128.
But, it was not added to the document, so an explanation was added.

* Update docs/middleware.md

---------

Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
  • Loading branch information
junah201 and Kludex committed Mar 25, 2024
1 parent 2e504fd commit 89fae17
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/middleware.md
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

0 comments on commit 89fae17

Please sign in to comment.