ref(types): Add undefined
as possible value to EventType
#6584
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.
Fixes #6575
As described in the issue, setting an
Event
's propertytype: undefined
, like we do in the SDK forErrorEvent
ssentry-javascript/packages/types/src/event.ts
Lines 68 to 70 in aad38ab
causes a TS error, whenever the recommended
exactOptionalPropertyTypes
TS option is enabled. This option was introduced in TS 4.4. Since we're on TS 3.8, we couldn't catch this error.This PR changes to
EventType
type declaration to also acceptundefined
as a value, thereby resolving the TS error.Note:
The initially suggested fix to change the
Event
'stype
type totype: EventType | undefined
causes TS errors all over the place as it would require us to settype
explicitly toundefined
whenever we create error events. I'd vote not to do this as it is a breaking change because it makes an optional parameter non-optional. Furthermore, it requires a lot of changes and also increases bundle size