logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Progress::Any::Output - Assign output to progress indicators

Author

       perlancar <perlancar@cpan.org>

Bugs

       Please report any bugs or feature requests on the bugtracker website
       <https://rt.cpan.org/Public/Dist/Display.html?Name=Progress-Any>

       When submitting a bug or request, please include a test-file or a patch to an existing test-file that
       illustrates the bug or desired feature.

perl v5.36.0                                       2022-10-30                         Progress::Any::Output(3pm)

Contributing

       To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

       Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then
       test via:

        % prove -l

       If you want to build the distribution (e.g. to try to install 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.

Description

       See Progress::Any for overview.

Homepage

       Please visit the project's homepage at <https://metacpan.org/release/Progress-Any>.

Methods

Progress::Any::Output->set([\%opts],$output[,@args])=>obj
       Set (or replace) output. Will load and instantiate "Progress::Any::Output::$output". To only set output
       for a certain (sub)task, set %opts to "{ task => $task }". @args will be passed to output module's
       constructor.

       Return the instantiated object.

       If $output is an object (a reference, really), it will be used as-is.

   Progress::Any::Output->add([\%opts],$output[,@args])
       Like set(), but will add output instead of replace existing one(s).

Name

       Progress::Any::Output - Assign output to progress indicators

See Also

       Progress::Any

Source

       Source repository is at <https://github.com/perlancar/perl-Progress-Any>.

Synopsis

       In your application:

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

       or:

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

       To give parameters to output:

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

       or:

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

       To assign output to a certain (sub)task:

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

       or:

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

       To add additional output, use "add()" instead of "set()".

Version

       This document describes version 0.220 of Progress::Any::Output (from Perl distribution Progress-Any),
       released on 2022-10-18.

See Also