docs(serve-static/bun,deno): add precompressed (#484)

honojs · Sep 11, 2024 · 72c9639 · 72c9639
1 parent 6dab580
commit 72c9639
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/docs/getting-started/bun.md b/docs/getting-started/bun.md
@@ -150,6 +150,19 @@ app.get(
 )
 ```
 
+### `precompressed`
+
+The `precompressed` option checks if files with extensions like `.br` or `.gz` are available and serves them based on the `Accept-Encoding` header. It prioritizes Brotli, then Zstd, and Gzip. If none are available, it serves the original file.
+
+```ts
+app.get(
+  '/static/*',
+  serveStatic({
+    precompressed: true,
+  })
+)
+```
+
 ## Testing
 
 You can use `bun:test` for testing on Bun.

diff --git a/docs/getting-started/deno.md b/docs/getting-started/deno.md
@@ -137,6 +137,19 @@ app.get(
 )
 ```
 
+### `precompressed`
+
+The `precompressed` option checks if files with extensions like `.br` or `.gz` are available and serves them based on the `Accept-Encoding` header. It prioritizes Brotli, then Zstd, and Gzip. If none are available, it serves the original file.
+
+```ts
+app.get(
+  '/static/*',
+  serveStatic({
+    precompressed: true,
+  })
+)
+```
+
 ## Deno Deploy
 
 Deno Deploy is an edge runtime platform for Deno.