@helia/block-brokers 4.2.4 → 5.0.0

package/README.md

@@ -13,6 +13,68 @@
 
 > Block brokers for Helia
 
+# About
+
+<!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the @packageDocumentation section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
+This module contains Helia block brokers, currently for [bitswap](https://docs.ipfs.tech/concepts/bitswap/)
+and [Trustless Gateways](https://specs.ipfs.tech/http-gateways/trustless-gateway/).
+
+## Trustless Gateway Block Broker
+
+The TrustlessGatewayBlockBroker fetches blocks from HTTP gateways.
+
+## Example - Customizing fetch requests with custom headers
+
+It is possible to modify outgoing requests to (for example) include
+authentication information (such as a JWT token in a header).
+
+```typescript
+import { createHelia } from 'helia'
+import { trustlessGateway } from '@helia/block-brokers'
+import { unixfs } from '@helia/unixfs'
+import { CID } from 'multiformats/cid'
+import { concat } from 'uint8arrays/concat'
+import all from 'it-all'
+
+const helia = await createHelia({
+  blockBrokers: [
+    trustlessGateway({
+      transformRequestInit: (requestInit) => {
+        // modify the request init object as required
+        requestInit.headers = {
+          ...requestInit.headers,
+          'User-Agent': 'Helia Example Script'
+        }
+        return requestInit
+      }
+    })
+  ]
+})
+
+const cid = CID.parse('bafkreife2klsil6kaxqhvmhgldpsvk5yutzm4i5bgjoq6fydefwtihnesa')
+const fs = unixfs(helia)
+
+for await (const chunk of fs.cat(cid, {
+  signal: AbortSignal.timeout(10_000)
+})) {
+  console.info(chunk)
+}
+```
+
 # Install
 
 ```console