Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

chore: add default option extentions #3965

Merged
merged 1 commit into from
Dec 3, 2021

Conversation

achingbrain
Copy link
Member

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)

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)
@achingbrain achingbrain merged commit 0c269cf into master Dec 3, 2021
@achingbrain achingbrain deleted the fix/add-default-option-extensions branch December 3, 2021 13:20
This was referenced Jan 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant