Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow ok/err/okAsync/errAsync to accept zero arguments when returning void #584

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

macksal
Copy link

@macksal macksal commented Sep 19, 2024

When implementing a function returning a result, it's often that I need to construct an Ok<void> object. However, it's not so ergonomic to do this. ok must be passed an argument, even if you explicitly specify the void type. This leads to passing a "dummy" value:

return ok<void>(undefined);

Meanwhile, in Promise-land, it's perfectly acceptable to call Promise.resolve() with no arguments, which returns a Promise<void>.

Interestingly, TS allows a parameter to be omitted if it has type void. However, this does not work if the type is generic and has been expanded to void or a union containing void. See microsoft/TypeScript#29131

This PR adds additional overloads for ok, err, okAsync and errAsync that separate out the case where the argument type is void. This allows the following to work as expected:

return ok<void>();
return ok();

Copy link

changeset-bot bot commented Sep 19, 2024

⚠️ No Changeset found

Latest commit: 17e6a6f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant