Skip to content

feat: @halo wrapped function can accept halo instance as 'spinner' parameter#174

Open
YodaDaCoda wants to merge 1 commit into
manrajgrover:masterfrom
YodaDaCoda:master
Open

feat: @halo wrapped function can accept halo instance as 'spinner' parameter#174
YodaDaCoda wants to merge 1 commit into
manrajgrover:masterfrom
YodaDaCoda:master

Conversation

@YodaDaCoda

@YodaDaCoda YodaDaCoda commented Feb 10, 2023

Copy link
Copy Markdown

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 a spinner 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

  • Your branch is up-to-date with the base branch
  • You've included at least one test if this is a new feature
  • All tests are passing

Related Issues and Discussions

n/a

People to notify

n/a

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