Mark BaseTransactionMessage as deprecated#1146
Conversation
|
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
BundleMonUnchanged files (136)
No change in files bundle size Final result: ✅ View report in BundleMon website ➡️ |
|
Documentation Preview: https://kit-docs-flyikom35-anza-tech.vercel.app |
|
|
||
| /** | ||
| * @deprecated Use `TransactionMessage` instead. | ||
| * @todo In a future major version, remove the export |
There was a problem hiding this comment.
I think the codebase already has // TODO(#XYZ) In a future... style comments where #XYZ is the GitHub issue number.
Also, I think it would be semver-esque to land this, do a release, then remove the word export with a major Changeset and do another release. They will have been done on the same day, but that still follows semver.
Thoughts?
There was a problem hiding this comment.
Yep I agree, if we actually remove the export completely then that's a major. I don't think we need to rush to do that though, I'm happy to just mark as deprecated and remove it at some point. Note that this stack doesn't completely eliminate BaseTransactionMessage from Kit, only where it affected these types. So there will be some more refactoring needed to completely remove it.
I'll open an issue for that and put it in this comment though.
f4ff4f7 to
cecbf6d
Compare
|
Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up. |


Problem
We exported
BaseTransactionMessage, but as this stack shows in practice it's strictly better to useTransactionMessageinstead.Summary of Changes
BaseTransactionMessageas deprecated. This will encourage Kit users (and us) to gradually migrate toTransactionMessageBaseTransactionMessageand just have it as implementation detail for the structure ofTransactionMessage