Update exported signature of MigrationFunction#1274
Open
royalrex wants to merge 1 commit intocontentful:mainfrom
Open
Update exported signature of MigrationFunction#1274royalrex wants to merge 1 commit intocontentful:mainfrom
royalrex wants to merge 1 commit intocontentful:mainfrom
Conversation
mgoudy91
approved these changes
Nov 28, 2023
Contributor
mgoudy91
left a comment
mgoudy91
left a comment
There was a problem hiding this comment.
I took a look and came to the same conclusion and believe this is fairly safe (and correct).
Thanks for the contribution!
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Changing of MigrationFunction type. The context parameter should not be declared as optional.
Description
This PR removes the optional setting on the context parameter. This will hint typescript that the parameter will always be there. My research of your codebase indicates that the context will always be provided.
I assume that your intent with marking the context as optional, is to not force other developers to have context parameter present in their migration function signature. But that is not what is happening. Typescript is okay with "missing" parameters, but marking it optional as is, will force developers to null check the context object before using. This seems to be not needed.
Motivation and Context
Improves typescript type checking.
Todos
Screenshots (if appropriate):
Typescript before change with context parameter
Typescript after change with context parameter
Typescript after change with no context parameter
