fix: export transiently referenced types#2717
Merged
achingbrain merged 2 commits intomainfrom Sep 24, 2024
Merged
Conversation
When we export a function like:
```ts
export function (foo: Bar): Baz {
return { ... }
}
```
We have to also export the `Bar` type and any types it references,
otherwise typedoc cannot create the API docs for us.
Also swaps instances of `(default: foo)` to use `@default` jsdoc tags.
Merged
tysonclugg
added a commit
to tysonclugg/js-libp2p-gossipsub
that referenced
this pull request
Apr 16, 2025
Required since libp2p/js-libp2p#2717 landed which no longer exports `FloodSub` from `@libp2p/floodsub`.
tysonclugg
added a commit
to tysonclugg/js-libp2p-gossipsub
that referenced
this pull request
Aug 17, 2025
Required since libp2p/js-libp2p#2717 landed which no longer exports `FloodSub` from `@libp2p/floodsub`.
tysonclugg
added a commit
to tysonclugg/js-libp2p-gossipsub
that referenced
this pull request
Aug 17, 2025
Required since libp2p/js-libp2p#2717 landed which no longer exports `FloodSub` from `@libp2p/floodsub`.
This file contains hidden or 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
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.
When we export a function like:
We have to also export the
Bartype and any types it references, otherwise typedoc cannot create the API docs for us.Also swaps instances of
(default: foo)to use@defaultjsdoc tags.Change checklist