This repository has been archived by the owner on Feb 12, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
We can extend options passed to the core-api by defining an extension object, this is so we can pass http options to the http api client but still get type safety. We define a default extension type of `{}` so we don't need to define the extension in places we aren't extending it (e.g. ipfs-core). Problem is, JSDoc doesn't pick up the default extension object so we need to add it to the function definitions. Refs: #3917 (comment)
3 tasks
This was referenced Jan 21, 2022
This was referenced Jan 21, 2022
This was referenced Jan 29, 2022
This was referenced Aug 19, 2022
This was referenced Oct 31, 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.
We can extend options passed to the core-api by defining an extension
object, this is so we can pass http options to the http api client
but still get type safety.
We define a default extension type of
{}
so we don't need to definethe extension in places we aren't extending it (e.g. ipfs-core).
Problem is, JSDoc doesn't pick up the default extension object so we
need to add it to the function definitions.
Refs: #3917 (comment)