Add docs from gofiber/fiber@b9936a3

gofiber · Jun 26, 2024 · a8afce6 · a8afce6
1 parent 7ce11ca
commit a8afce6
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/docs/core/api/fiber.md b/docs/core/api/fiber.md
@@ -48,7 +48,7 @@ app := fiber.New(fiber.Config{
 | <Reference id="bodylimit">BodyLimit</Reference>                                       | `int`                                                             | Sets the maximum allowed size for a request body, if the size exceeds the configured limit, it sends `413 - Request Entity Too Large` response.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `4 * 1024 * 1024`                                                        |
 | <Reference id="casesensitive">CaseSensitive</Reference>                               | `bool`                                                            | When enabled, `/Foo` and `/foo` are different routes. When disabled, `/Foo`and `/foo` are treated the same.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | `false`                                                                  |
 | <Reference id="colorscheme">ColorScheme</Reference>                                   | [`Colors`](https://github.com/gofiber/fiber/blob/master/color.go) | You can define custom color scheme. They'll be used for startup message, route list and some middlewares.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`DefaultColors`](https://github.com/gofiber/fiber/blob/master/color.go) |
-| <Reference id="compressedfilesuffix">CompressedFileSuffix</Reference>                 | `string`                                                          | Adds a suffix to the original file name and tries saving the resulting compressed file under the new file name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `".fiber.gz"`                                                            |
+| <Reference id="compressedfilesuffixes">CompressedFileSuffixes</Reference>                 | `map[string]string`                                                          | Adds a suffix to the original file name and tries saving the resulting compressed file under the new file name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `{"gzip": ".fiber.gz", "br": ".fiber.br", "zstd": ".fiber.zst"}`                                                            |
 | <Reference id="concurrency">Concurrency</Reference>                                   | `int`                                                             | Maximum number of concurrent connections.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `256 * 1024`                                                             |
 | <Reference id="disabledefaultcontenttype">DisableDefaultContentType</Reference>       | `bool`                                                            | When set to true, causes the default Content-Type header to be excluded from the Response.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | `false`                                                                  |
 | <Reference id="disabledefaultdate">DisableDefaultDate</Reference>                     | `bool`                                                            | When set to true causes the default date header to be excluded from the response.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | `false`                                                                  |

diff --git a/docs/core/middleware/compress.md b/docs/core/middleware/compress.md
@@ -4,7 +4,7 @@ id: compress
 
 # Compress
 
-Compression middleware for [Fiber](https://github.com/gofiber/fiber) that will compress the response using `gzip`, `deflate` and `brotli` compression depending on the [Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) header.
+Compression middleware for [Fiber](https://github.com/gofiber/fiber) that will compress the response using `gzip`, `deflate`, `brotli`, and `zstd` compression depending on the [Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) header.
 
 :::note
 The compression middleware refrains from compressing bodies that are smaller than 200 bytes. This decision is based on the observation that, in such cases, the compressed size is likely to exceed the original size, making compression inefficient. [more](https://github.com/valyala/fasthttp/blob/497922a21ef4b314f393887e9c6147b8c3e3eda4/http.go#L1713-L1715)

diff --git a/docs/core/middleware/static.md b/docs/core/middleware/static.md
@@ -148,7 +148,7 @@ To define static routes using `Get`, append the wildcard (`*`) operator at the e
 |:-----------|:------------------------|:---------------------------------------------------------------------------------------------------------------------------|:-----------------------|
 | Next       | `func(fiber.Ctx) bool` | Next defines a function to skip this middleware when returned true.                                                                              | `nil`                  |
 | FS       | `fs.FS` | FS is the file system to serve the static files from.<br /><br />You can use interfaces compatible with fs.FS like embed.FS, os.DirFS etc.                                                 | `nil`                  |
-| Compress       | `bool` | When set to true, the server tries minimizing CPU usage by caching compressed files.<br /><br />This works differently than the github.com/gofiber/compression middleware.                                                                              | `false`                  |
+| Compress       | `bool` | When set to true, the server tries minimizing CPU usage by caching compressed files. The middleware will compress the response using `gzip`, `brotli`, or `zstd` compression depending on the [Accept-Encoding](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding) header. <br /><br />This works differently than the github.com/gofiber/compression middleware.                                                                              | `false`                  |
 | ByteRange       | `bool` | When set to true, enables byte range requests.                                                                             | `false`                  |
 | Browse       | `bool` | When set to true, enables directory browsing.                                                                             | `false`                  |
 | Download       | `bool` | When set to true, enables direct download.                                                                             | `false`                  |

diff --git a/docs/core/whats_new.md b/docs/core/whats_new.md
@@ -263,6 +263,10 @@ We've updated several fields from a single string (containing comma-separated va
 - `Config.AllowHeaders`: Now accepts a slice of strings, each representing an allowed header.
 - `Config.ExposeHeaders`: Now accepts a slice of strings, each representing an exposed header.
 
+### Compression
+
+We've added support for `zstd` compression on top of `gzip`, `deflate`, and `brotli`.
+
 ### Session
 
 :::caution