Fix FirebaseServerApp Typescript exactOptionalPropertyTypes error #8341
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
🦋 Changeset detectedLatest commit: ad7a9ad The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected ProductsNo changes between base commit (ed1c993) and merge commit (0b145e1).Test Logs |
Size Analysis Report 1Affected ProductsNo changes between base commit (ed1c993) and merge commit (0b145e1).Test Logs |
Changeset File Check ✅
|
DellaBitta
commented
Jul 1, 2024
| // | ||
| // @public | ||
| export function isWebWorker(): boolean; | ||
|
|
There was a problem hiding this comment.
Apparently I missed the doc generate step on the user-created PR that added this function (#8315). My bad.
egilmorez
approved these changes
Jul 1, 2024
Merged
tom-andersen
pushed a commit
that referenced
this pull request
Jul 24, 2024
) This change fixes a TypeScript compilation error. The `FirebaseServerAppSettings.name` field inherited from `FirebaseAppSettings` but the type was redefined from `string` to `undefined`. This redefinition would cause a TypeScript compliation error if `exactOptionalPropertyTypes` was set `true` in `packages/app/tsconfig.json`. This change now uses `omit< , >` to strip the `name` field from the `FirebaseServerAppSettings` declaration, where `FirebaseAppSettings` is extended. Fixes #8336
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Discussion
This change fixes a TypeScript compilation error.
The
FirebaseServerAppSettings.namefield inherited fromFirebaseAppSettingsbut the type was redefined fromstringtoundefined. This redefinition would cause a TypeScript compliation error ifexactOptionalPropertyTypeswas settrueinpackages/app/tsconfig.json.This change now uses
omit< , >to strip thenamefield from theFirebaseServerAppSettingsdeclaration, whereFirebaseAppSettingsis extended.Fixes #8336
Testing
exactOptionalPropertyTypessetting defined astrue.API Changes
While the type definition of
FirebaseServerAppSettingshas changed visually, the effective signature is the same. In both versions ofFirebaseServerAppSettingsthe use of thenamefield would result in TypeScript compliation errors. I ensured this by creating a simple TypeScript app that attempted to use thenamefield, and compiled against the two varyingFirebaseServerAppSettingsdefinitiions.