Change TS types to use type declarations from PN JS SDK #155
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
…mmunity driven @types/pubnub
wkal-pubnub
commented
Jan 9, 2025
parfeon
requested changes
Jan 14, 2025
src/jsMain/resources/index.d.ts
Outdated
| userMetadata?: { | ||
| [key: string]: any; | ||
| }; | ||
| }; | ||
| type MessageDTOParams = PubNub.FetchMessagesResponse["channels"]["channel"][0] | EnhancedMessageEvent; | ||
| type MessageDTOParams = History.FetchMessagesResponse["channels"]["channel"][0] | EnhancedMessageEvent; |
There was a problem hiding this comment.
Suggested change
| type MessageDTOParams = History.FetchMessagesResponse["channels"]["channel"][0] | EnhancedMessageEvent; | |
| type MessageDTOParams = History.FetchMessagesForChannelsResponse['channels'][string][number] | History.FetchMessagesWithActionsResponse['channels'][string][number] | EnhancedMessageEvent; |
I don't know where it used, just assuming what it expected to reflect.
There was a problem hiding this comment.
just checking that I should change [0] to [number] ? (I don't know TS types that well so wanted to make sure it's not a mistake)
There was a problem hiding this comment.
Because there is actually no array, we are speaking about type declaration. With this annotation, we are telling TS that we need the type of the single entry for the array of messages for channel name stored as a string.
Sadly, we have to use explicit types which have been unified under FetchMessagesResponse because TS will end up with specifying any because it can't figure out :/
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.
(instead of community driven
@types/pubnub)