Allow info to be null on getProfileInfo #232
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
jaller94
approved these changes
Sep 17, 2020
src/components/intent.ts
Outdated
| @@ -520,7 +520,7 @@ export class Intent { | |||
| * @return A Promise that resolves with the requested user's profile | |||
| * information | |||
| */ | |||
| public async getProfileInfo(userId: string, info: string, useCache=true) { | |||
| public async getProfileInfo(userId: string, info: "avatar_url"|"displayname"|null = null, useCache = true) { | |||
There was a problem hiding this comment.
Are "avatar_url"|"displayname" the only values that profile.get() supports?
TypeScript becomes a pain if Types are incorrectly too strict.
But if they are the only reasonable values, great to help bridges using this library to spell them correctly.
There was a problem hiding this comment.
The spec doesn't allow arbitrary keys, and it's been that way for as long as Matrix has been around. We can update this if the spec changes at some point.
jaller94
suggested changes
Sep 17, 2020
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.
We use this in various places on the Slack bridge to get the full profile of a user.