NAME

App::ChromeUtils - Utilities related to Google Chrome browser

VERSION

This document describes version 0.008 of App::ChromeUtils (from Perl distribution App-ChromeUtils), released on 2020-08-18.

SYNOPSIS

DESCRIPTION

This distribution includes several utilities related to Google Chrome browser:

FUNCTIONS

chrome_has_processes

Usage:

 chrome_has_processes(%args) -> [status, msg, payload, meta]

Check whether Chrome has processes.

This function is not exported.

Arguments ('*' denotes required arguments):

  • quiet => true

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

chrome_is_paused

Usage:

 chrome_is_paused(%args) -> [status, msg, payload, meta]

Check whether Chrome is paused.

Chrome is defined as paused if all of its processes are in 'stop' state.

This function is not exported.

Arguments ('*' denotes required arguments):

  • quiet => true

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

chrome_is_running

Usage:

 chrome_is_running(%args) -> [status, msg, payload, meta]

Check whether Chrome is running.

Chrome is defined as running if there are some Chrome processes that are not in 'stop' state. In other words, if Chrome has been started but is currently paused, we do not say that it's running. If you want to check if Chrome process exists, you can use ps_chrome.

This function is not exported.

Arguments ('*' denotes required arguments):

  • quiet => true

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

pause_chrome

Usage:

 pause_chrome(%args) -> [status, msg, payload, meta]

Pause (kill -STOP) Chrome.

A modern browser now runs complex web pages and applications. Despite browser's power management feature, these pages/tabs on the browser often still eat considerable CPU cycles even though they only run in the background. Stopping (kill -STOP) the browser processes is a simple and effective way to stop CPU eating on Unix. It can be performed whenever you are not using your browser for a little while, e.g. when you are typing on an editor or watching a movie. When you want to use your browser again, simply unpause it.

This function is not exported.

Arguments ('*' denotes required arguments):

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

ps_chrome

Usage:

 ps_chrome(%args) -> [status, msg, payload, meta]

List Chrome processes.

This function is not exported.

Arguments ('*' denotes required arguments):

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

restart_chrome

Usage:

 restart_chrome(%args) -> [status, msg, payload, meta]

Restart chrome.

This function is not exported.

This function supports dry-run operation.

Arguments ('*' denotes required arguments):

  • chrome_cmd => array[str]|str (default: "google-chrome")

  • quiet => true

Special arguments:

  • -dry_run => bool

    Pass -dry_run=>1 to enable simulation mode.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

start_chrome

Usage:

 start_chrome(%args) -> [status, msg, payload, meta]

Start chrome if not already started.

This function is not exported.

This function supports dry-run operation.

Arguments ('*' denotes required arguments):

  • chrome_cmd => array[str]|str (default: "google-chrome")

  • quiet => true

Special arguments:

  • -dry_run => bool

    Pass -dry_run=>1 to enable simulation mode.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

terminate_chrome

Usage:

 terminate_chrome(%args) -> [status, msg, payload, meta]

Terminate (kill -KILL) Chrome.

This function is not exported.

Arguments ('*' denotes required arguments):

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

unpause_chrome

Usage:

 unpause_chrome(%args) -> [status, msg, payload, meta]

Unpause (resume, continue, kill -CONT) Chrome.

This function is not exported.

Arguments ('*' denotes required arguments):

  • users => array[unix::local_uid]

    Kill browser processes that belong to certain user(s) only.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (payload) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-ChromeUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-ChromeUtils.

BUGS

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

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.

SEE ALSO

Some other CLI utilities related to Chrome: dump-chrome-history (from App::DumpChromeHistory).

App::FirefoxUtils

App::OperaUtils

App::VivaldiUtils

App::BrowserUtils

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2019 by 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.