feat!: methods with out
parameters now return a Record
#299
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.
Description
Here are three scenarios to consider when modifying method signatures:
1-) void methods with a single
out
parameterWhen dealing with void methods that have a single out parameter, the return type of the method is replaced with the type of the out parameter.
For instance, consider the following method:
The modified signature would look like this:
2-) void methods with multiple
out
parametersIn the case of void methods with multiple out parameters, the return type is changed to a
Record
with named parameters corresponding to the out parameters' types.For example:
The updated signature would be:
3-) non-void methods with
out
parameter(s)Finally, when dealing with non-void methods that have out parameter(s), the return type is transformed into a
Record
with one positional parameter representing the original return type and named parameters representing the out parameters' types.For instance:
The modified signature would be:
Related Issue
Fixes #284
Type of Change
feat
-- New feature (non-breaking change which adds functionality)fix
-- Bug fix (non-breaking change which fixes an issue)!
-- Breaking change (fix or feature that would cause existing functionality to change)refactor
-- Code refactorci
-- Build configuration changedocs
-- Documentationtest
-- Testchore
-- Chore