Progre...:Output(3pm)

💖 NAME 💖

okay so bestie, this is Progress::Any::Output — it's the module that assigns output to progress indicators. that's the whole vibe. ✨

it lives in the Perl docs under Progre...:Output(3pm) if you're out here searching for it, and honestly? iconic name truncation. we love her. 🎀

---

🌸 VERSION 🌸

this doc describes version 0.220 of Progress::Any::Output, which comes from the Perl distribution Progress-Any, and it was released on 2022-10-18. no cap, that's the tea. 🦋

---

✨ SYNOPSIS ✨

okay so here's how you actually use it. in your application:

use Progress::Any::Output;
Progress::Any::Output->set('TermProgressBarColor');

or, if you're feeling efficient:

use Progress::Any::Output 'TermProgressBarColor';

and if you wanna give parameters to your output (yes, you can do that, she's flexible 💅):

use Progress::Any::Output;
Progress::Any::Output->set('TermProgressBarColor', width=>50, ...);

or the one-liner way:

use Progress::Any::Output 'TermProgressBarColor', width=>50, ...;

now, to assign output to a certain (sub)task — yes, subtasks, we're being specific here:

use Progress::Any::Output -task => "main.download", 'TermMessage';

or:

use Progress::Any::Output;
Progress::Any::Output->set({task=>'main.download'}, 'TermMessage');

and listen: to add additional output instead of replacing what's already there, you use add() instead of set(). important. don't skip that part. 🫶

---

💜 DESCRIPTION 💜

for the big-picture overview, go peek at Progress::Any. this page is just the output-assignment side of the story. 🌈

---

👑 METHODS 👑

Progress::Any::Output->set([ \%opts ], $output[, @args]) => obj

set (or replace) your output. she will load and instantiate Progress::Any::Output::$output for you. ✨

if you only wanna set output for a certain (sub)task, you set %opts to { task => $task }. and @args? those get passed straight to the output module's constructor, no questions asked.

she returns the instantiated object. 🎁

and plot twist: if $output is already an object (a reference, really), it'll be used as-is. no re-wrapping, no drama. 💅

Progress::Any::Output->add([ \%opts ], $output[, @args])

exactly like set(), bestie, but it adds output instead of replacing the existing one(s). the more the merrier energy. 💖

---

🔥 HOMEPAGE 🔥

the project's homepage is over at <https://metacpan.org/release/Progress-Any>. go say hi. 🦋

---

⭐ SOURCE ⭐

the source repository lives at <https://github.com/perlancar/perl-Progress-Any>. yes, it's on GitHub, we're modern like that. 💅

---

🌸 SEE ALSO 🌸

• Progress::Any

that's it. that's the whole list. short and slay. ✨

---

🎀 AUTHOR 🎀

perlancar <perlancar@cpan.org> — the icon, the legend, the moment. 👑

---

🫶 CONTRIBUTING 🫶

wanna contribute? you absolutely can, bestie. you can send patches by email/via RT, or send pull requests on GitHub. pick your fighter. 🦋

and most of the time? you don't even need to build the distribution yourself. nope. you can simply modify the code, then test it via:

% prove -l

if you do wanna build the distribution (like, say, to try installing it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins.

any additional steps required beyond that are considered a bug and can be reported to me. so if you find extra steps, that's not a feature, that's a bug. 🚨

---

💖 COPYRIGHT AND LICENSE 💖

this software is copyright (c) 2022, 2020, 2018, 2015, 2014, 2013, 2012 by perlancar <perlancar@cpan.org>.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. periodt. 💅

---

💀 BUGS 💀

please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Progress-Any>. don't suffer in silence, bestie, that's not the vibe. 😭

and when you submit a bug or a request, please include a test-file or a patch to an existing test-file that illustrates the bug or the desired feature. receipts matter. 🧚

---

okay so that's the whole page, and the tea at the bottom is: this is from perl v5.36.0, dated 2022-10-30, and it's Progre...:Output(3pm) — go forth and assign your outputs, main character. 💖✨🎀🦋