feat: @halo wrapped function can accept halo instance as 'spinner' parameter #174
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 of new feature, or changes
When wrapping a function with
@Halo
syntax the wrapped function has no access to the spinner and therefore cannot do any of the extra stuff with the spinner, such as change the text. With this change, if the wrapped function accepts aspinner
parameter, the halo instance is passed as the value for that parameter.Considerations: If the wrapped function is called passing a value to the
spinner
parameter, this may override it or produce an error, I'm unclear. The behaviour here, or the possibility to configure the name of the parameter, are things I've considered but not put effort into implementing - love to discuss.(the change is working great as-is in a personal project of mine)
TODO: tests, based on outcome of above discussion.
Checklist
Related Issues and Discussions
n/a
People to notify
n/a