fix(release): remove unnecessary number from release return type#34481
Merged
fix(release): remove unnecessary number from release return type#34481
Conversation
The release function always returns NxReleaseVersionResult, so the union with number in the return type was inaccurate and could mislead consumers of the API. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for nx-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
View your CI Pipeline Execution ↗ for commit 78c84c4
☁️ Nx Cloud last updated this comment at |
JamesHenry
approved these changes
Feb 17, 2026
FrozenPandaz
pushed a commit
that referenced
this pull request
Feb 20, 2026
) ## Current Behavior The `release` function returned by `createAPI` has a return type of `Promise<NxReleaseVersionResult | number>`. The `| number` union member is inaccurate since the function always returns `NxReleaseVersionResult`, which can mislead consumers of the programmatic API. ## Expected Behavior The return type is narrowed to `Promise<NxReleaseVersionResult>`, accurately reflecting what the function actually returns and giving API consumers correct type information. Co-authored-by: Andreas Hörnicke <andreas.hoernicke@contentful.com> (cherry picked from commit 0c14bcb)
Contributor
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Current Behavior
The
releasefunction returned bycreateAPIhas a return type ofPromise<NxReleaseVersionResult | number>. The| numberunion member is inaccurate since the function always returnsNxReleaseVersionResult, which can mislead consumers of the programmatic API.Expected Behavior
The return type is narrowed to
Promise<NxReleaseVersionResult>, accurately reflecting what the function actually returns and giving API consumers correct type information.