This repository has been archived by the owner on Jul 12, 2023. It is now read-only.
feat: export some types so they render in docs #211
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
Exports the following: - `CreateAudioResourceOptions` (parameter type in `createAudioResource`) - `JoinConfig` (parameter type in `createVoiceConnection` and `VoiceConnection#rejoin`) - `SpeakingMap` (type of `VoiceReceiver#speaking`) and `SpeakingMapEvents` This is mainly so that these types show in the documentation. There are some more unexported types referenced in the docs that I haven't exported because they seem more internal: - `Awaited` - `Edge` - `Networking` This commit also documents the overloads for `createAudioResource` and `getVoiceConnections`. Previously, no documentation would be rendered for these two functions as Typedoc only considers the documentation for each overload.
Codecov Report
@@ Coverage Diff @@
## main #211 +/- ##
=======================================
Coverage 73.84% 73.84%
=======================================
Files 21 21
Lines 906 906
Branches 221 221
=======================================
Hits 669 669
Misses 235 235
Partials 2 2
Continue to review full report at Codecov.
|
SpaceEEC
approved these changes
Oct 1, 2021
J-Human
approved these changes
Oct 3, 2021
iCrawl
approved these changes
Oct 27, 2021
iCrawl
reviewed
Oct 27, 2021
iCrawl
reviewed
Oct 27, 2021
iCrawl
reviewed
Oct 27, 2021
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.
Please describe the changes this PR makes and why it should be merged:
This PR exports the following:
CreateAudioResourceOptions(parameter type increateAudioResource)JoinConfig(parameter type increateVoiceConnectionandVoiceConnection#rejoin)SpeakingMap(type ofVoiceReceiver#speaking) andSpeakingMapEventsThis is mainly so that these types show in the documentation, but I think these should be exported regardless of the documentation anyway.
There are some more unexported types referenced in the docs that I haven't exported because they seem more internal:
AwaitedEdge(AudioResource#edges)Networking(VoiceConnection(Connecting|Ready)State#networking)ConnectionData(VoiceReceiver#connectionDatawhich is@internal)(if these should be exported as well I'll export them as well)
This PR also documents the overloads for
createAudioResourceandgetVoiceConnections. Currently, no documentation is rendered for these two functions as TypeDoc only considers the documentation for each overload.https://typedoc.org/guides/options/#excludeinternal
Status and versioning classification:
I think this counts as changing the library's interface because it exports some more types.
Unrelated to the PR but maybe the TypeDoc
--excludeInternaloption might be handy to exclude documenting@internalitems?