Corrected setUser TS interface to allow for null arguments #2262
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.
Goal
The
setUser
method in the notifier can take null as a parameter to clear the value from the user object. The current TypeScript interface only allows forstring | undefined
, which causes type errors when trying to pass null as a parameter.BugSnag documentation mentions passing null to
setUser
as a possibility.Design
The type definition has been updated to accurately reflect the capabilities od the notifier.
Changeset
The type definition for
setUser
's arguments has been extended fromid?: string
toid?: string | null
.Testing
The change was tested manually.