This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
fix: update types after feedback from ceramic #3657
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
Some of the types need a little correcting. Fixes #3640
vasco-santos
pushed a commit
that referenced
this pull request
Apr 30, 2021
Some of the types need a little correcting. Fixes #3640
vasco-santos
pushed a commit
that referenced
this pull request
Apr 30, 2021
Some of the types need a little correcting. Fixes #3640
rvagg
reviewed
May 3, 2021
| @@ -117,7 +117,7 @@ export interface Options { | |||
| * in Node.js, [`libp2p-browser.js`](../src/core/runtime/libp2p-browser.js) in | |||
| * browsers. | |||
| */ | |||
| libp2p?: Libp2pOptions | Libp2pFactoryFn | |||
| libp2p?: Partial<Libp2pOptions> | Libp2pFactoryFn | |||
There was a problem hiding this comment.
TIL about Partial<>.
What's the reason for doing this here, is Libp2pOptions too constrained, or is this what getLibp2pOptions() is doing, filling out defaults for the required?
There was a problem hiding this comment.
The libp2p option type has a bunch of required fields, so make it a partial so we can accept an incomplete config object from the user. Otherwise we’d have to duplicate the type to mark the fields optional.
It’s not perfect as it’s non-recursive so if that’s an issue maybe we can relax the required fields in libp2p itself in the future.
This was referenced Mar 21, 2022
This was referenced Dec 6, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Some of the types need a little correcting.
Fixes #3640