docs: explain server timing header capabilities

ipfs · Jan 9, 2025 · 1586f62 · 1586f62
1 parent f4c09ef
commit 1586f62
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/verified-fetch/src/index.ts b/packages/verified-fetch/src/index.ts
@@ -604,6 +604,14 @@
  * * https://specs.ipfs.tech/http-gateways/trustless-gateway/#response-headers
  * * https://specs.ipfs.tech/http-gateways/subdomain-gateway/#response-headers
  *
+ * #### Server Timing headers
+ *
+ * By default, we do not include Server Timing headers in the response. If you want to include them, you can pass an
+ * `includeServerTiming` option to the `createVerifiedFetch` function to include them in all future responses. You can
+ * also pass the `includeServerTiming` option to each fetch call to include them only for that specific response.
+ *
+ * @see https://github.com/ipfs/helia-verified-fetch/pull/164 for more information.
+ *
  * ### Possible Scenarios that could cause confusion
  *
  * #### Attempting to fetch the CID for content that does not make sense