From: Jun-Ah 준아 Date: Mon, 25 Mar 2024 17:57:47 +0000 (+0900) Subject: Add missing `compresslevel` parameter on docs (#2553) X-Git-Tag: 0.38.0~20 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=89fae174a1ea10f59ae248fe030d9b7e83d0b8a0;p=thirdparty%2Fstarlette.git Add missing `compresslevel` parameter on docs (#2553) * 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 --- diff --git a/docs/middleware.md b/docs/middleware.md index 759c86d7..dfe0a70d 100644 --- a/docs/middleware.md +++ b/docs/middleware.md @@ -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) @@ -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.