[MOB-6063] updates parameter types for setEmail and setUserId #491
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
Ayyanchira
reviewed
May 17, 2023
ts/Iterable.ts
Outdated
| * @param {string | undefined} authToken valid, pre-fecthed JWT the SDK can use to authenticate API requests, optional - if null/undefined, no JWT related action will be taken | ||
| */ | ||
|
|
||
| static setEmail(email: string | undefined, authToken?: string | undefined) { | ||
| static setEmail(email: string | null, authToken?: string | null) { |
There was a problem hiding this comment.
I think @pauljung14 suggested to have undefined AND null both.
so it will be string | undefined | null
There was a problem hiding this comment.
You can find my suggestion in the comments of the JIRA ticket
There was a problem hiding this comment.
Ah gotcha. I was thinking that we wanted the email to be required. But, I will make the change.
There was a problem hiding this comment.
I think we need to verify what behavior occurs when the user is undefined. Are we logging out the user?
Ayyanchira
reviewed
May 19, 2023
| * @param {string | undefined} authToken valid, pre-fecthed JWT the SDK can use to authenticate API requests, optional - if null/undefined, no JWT related action will be taken | ||
| */ | ||
|
|
||
| static setEmail(email: string | undefined, authToken?: string | undefined) { | ||
| static setEmail(email?: string | null, authToken?: string | null) { |
There was a problem hiding this comment.
The null and undefined changes will go here
| * optional parameter: @param {string | undefined} authToken valid, pre-fecthed JWT the SDK can use to authenticate API requests, optional - if null/undefined, no JWT related action will be taken | ||
| */ | ||
|
|
||
| static setUserId(userId: string | undefined, authToken?: string | undefined) { |
added 2 commits
June 28, 2023 11:42
evantk91
deleted the
evan/MOB-6063-update-setEmail-setUserId-parameter-types
branch
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.
🔹 JIRA Ticket(s) if any
✏️ Description
This pull request updates the parameter types for setEmail and setUserId. This stems from reported issues with setEmail as discussed here. In our documentation, we ask customers to pass in a value of null to log out.