feat: allow use as a singleton #413
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To allow no-option, all-defaults construction of verified fetch
```TypeScript
import { createVerifiedFetch } from '@helia/verified-fetch'
const fetch = await createVerifiedFetch()
const resp = await fetch('ipfs://bafy...')
// ...
```
This might make things even easier to get started?
```TypeScript
import { verifiedFetch } from '@helia/verified-fetch'
const response = await verifiedFetch('ipfs://Qmfoo')
console.info(await response.json())
```
It's not in this PR but maybe we'd want to allow some config:
```TypeScript
import { verifiedFetch } from '@helia/verified-fetch'
const response = await verifiedFetch('ipfs://Qmfoo', {
gateways: ['https://...']
})
console.info(await response.json())
```
Calling this twice with different gateways might result in an error.
```TypeScript
import { verifiedFetch } from '@helia/verified-fetch'
const response1 = await verifiedFetch('ipfs://Qmfoo', {
gateways: ['https://foo...']
})
const response2 = await verifiedFetch('ipfs://Qmfoo', {
gateways: ['https://bar...']
})
// Error: Only one set of gateways/routers may be specified, please use `createVerifiedFetch` for more flexibility
```
2color
reviewed
Feb 2, 2024
Co-authored-by: Daniel Norman <1992255+2color@users.noreply.github.com>
SgtPooki
approved these changes
Feb 2, 2024
I think we should leave the singleton to the most basic, unconfigurable, usecase and have users use createVerifiedFetch if they want to customize gateways, so that we don't have to muck around with error and edge-cases or confusion on the second options argument. |
Base automatically changed from
fix/make-verified-fetch-init-optional
to
main
February 2, 2024 18:06
SgtPooki
approved these changes
Feb 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This might make things even easier to get started? It exports a singleton version of verified fetch that creates the backing Helia node on the first fetch access, transparent to the user.
It's not in this PR but maybe we'd want to allow some config:
Calling this twice with different gateways might result in an error.