Chrome:...rotocol(3)

📦
version 0.78 · 3 versions
, in fedora 43, fedora 44

✨ NAME ✨

okay so Chrome::DevToolsProtocol is an asynchronous dispatcher for the DevTools protocol. that's it, that's the vibe. no cap. 💅

🦋 SYNOPSIS 🦋

# Usually, WWW::Mechanize::Chrome automatically creates a driver for you
my $driver = Chrome::DevToolsProtocol->new(
    port => 9222,
    host => '127.0.0.1',
    auto_close => 0,
    error_handler => sub {
        # Reraise the error
        croak $_[1]
    },
);
$driver->connect( new_tab => 1 )->get

like. look at her. she's doing everything. 🌸

💖 METHODS 💖

💫 ->new( %args ) 💫

my $driver = Chrome::DevToolsProtocol->new(
    port => 9222,
    host => '127.0.0.1',
    auto_close => 0,
    error_handler => sub {
        # Reraise the error
        croak $_[1]
    },
);

most of these lil members can be set through the constructor arguments, bestie:

  • host — the hostname to connect to 🫶
  • port — the port to connect to
  • json — the JSON decoder used
  • ua — the Future::HTTP instance to talk to the Chrome DevTools
  • tab — which tab to reuse (if any)
  • log — a premade Log::Log4perl object to act as logger
  • transport — the event-loop specific transport backend

💫 ->future 💫

my $f = $driver->future();

returns a backend-specific generic future ✨

💫 ->endpoint 💫

my $url = $driver->endpoint();

returns the URL endpoint to talk to for the connected tab 🌈

💫 json_log_fh 💫

the filehandle where all communications get logged to, one line per message/response. every line is gonna look like this:

{ type: "message", payload: { ... } }
{ type: "reply", payload: { ... } }
{ type: "event", payload: { ... } }
🚨 the filehandle must be opened as :raw, because UTF-8 encoded bytes are getting written to it. no exceptions bestie.

💫 ->add_listener 💫

my $l = $driver->add_listener(
    'Page.domContentEventFired',
    sub {
        warn "The DOMContent event was fired";
    },
);

# ...

undef $l; # stop listening

adds a callback for the given event name. and the way that the callback gets removed the moment the return value goes out of scope?? iconic behaviour fr fr. ✨

💫 ->remove_listener 💫

$driver->remove_listener($l);

explicitly remove a listener. sometimes you just gotta say bye 👋

💫 ->log 💫

$driver->log('debug', "Warbling doodads", { doodad => 'this' } );

log a message 💜

💫 ->connect 💫

my $f = $driver->connect()->get;

asynchronously connect to the Chrome browser, returning a Future. slay.

💫 ->close 💫

$driver->close();

shut down the connection to Chrome 🎀

💫 ->sleep 💫

$driver->sleep(0.2)->get;

sleep for the amount of seconds in an event-loop compatible way. beauty sleep but make it async 😴

💫 ->one_shot 💫

my $f = $driver->one_shot('Page.domContentEventFired')->get;

returns a future that resolves when the event is received ⭐

💫 $chrome->json_get 💫

my $data = $driver->json_get( 'version' )->get;

requests an URL and returns decoded JSON from the future 🌸

💫 $chrome->send_packet 💫

$chrome->send_packet('Page.handleJavaScriptDialog',
    accept => JSON::true,
);

sends a JSON packet to the remote end 📨

💫 $chrome->send_message 💫

my $future = $chrome->send_message('DOM.querySelectorAll',
    selector => 'p',
    nodeId => $node,
);
my $nodes = $future->get;

this function expects a response. the future will not be resolved until Chrome has sent a response to this query. like she's waiting. patiently. 💅

💫 $chrome->callFunctionOn 💫

💫 $chrome->evaluate 💫

💫 $chrome->eval 💫

my $result = $chrome->eval('2+2');

evaluates a Javascript string and returns the result. yes she does math 💖

💫 $chrome->version_info 💫

print $chrome->version_info->get->{"Protocol-Version"};

returns the implemented ChromeDevTooslProtocol protocol version. (that spelling is the original's, don't come for me 🫶)

💫 $chrome->protocol_version 💫

print $chrome->protocol_version->get;

💫 $target->getVersion 💫

returns information about the Chrome instance we are connected to. get to know her 👑

💫 $chrome->get_domains 💫

my $schema = $chrome->get_domains->get;

returns the topics of this Chrome DevToolsProtocol implementation 🌈

💫 $chrome->list_tabs 💫

my @tabs = $chrome->list_tabs->get();

💫 $chrome->new_tab 💫

my $new_tab = $chrome->new_tab('https://www.google.com')->get;

💫 $chrome->activate_tab 💫

$chrome->activate_tab( $tab )->get

brings the tab to the foreground of the application. main character energy, literally. ✨

💫 $chrome->close_tab 💫

$chrome->close_tab( $tab )->get

closes the tab 🎀

💫 $chrome->getTargets 💫

my @targets = $chrome->getTargets->get;

gets the list of available targets 🎯

💫 $target->getTargetInfo 💫

my $info = $chrome->getTargetInfo( $targetId )->get;
print $info->{title};

returns information about the current target 🌸

💫 $target->createTarget 💫

my $targetId = $chrome->createTarget(
    url => 'about:blank',
    width => 1280,
    height => 800,
    newWindow => JSON::false,
    background => JSON::false,
)->get;
print $targetId;

creates a new target, optionally in a new window 🪟

💫 $target->attachToTarget 💫

my $sessionId = $chrome->attachToTarget(
    targetId => $targetId,
)->get;
print $sessionId;

attaches to the target so we receive events generated by the target 👀

💫 $target->closeTarget 💫

my $targetId = $chrome->closeTarget(
    targetId => $targetId
)->get;

creates a new target 🙈 (yes bestie, that's literally what the page says for closeTarget. I'm just the messenger. copy/paste energy, we don't gatekeep.)

💫 $target->getWindowForTarget 💫

my $info = $chrome->getWindowForTarget( $targetId )->get;
print $info->{windowId};

returns information about the window of the current target 🪟✨

💫 $target->setWindowBoundsForTarget 💫

my $info = $chrome->getWindowForTarget( $targetId )->get;
$info->{bounds}->{width} = 100;
$chrome->setWindowBounds( $info->{windowId}, $info->{bounds} )->get;

sets the window dimensions of the current target 📐

💫 $chrome->getBrowserContexts 💫

my @browserContextIds = $chrome->getBrowserContexts->get;

gets the list of available browser contexts. these are separate sets of user cookies etc. so like, different personalities, different cookie jars 🍪

🌈 SEE ALSO 🌈

🧚 REPOSITORY 🧚

the public repository of this module is <https://github.com/Corion/www-mechanize-chrome>. go star her, she deserves it ⭐

🫶 SUPPORT 🫶

the public support forum of this module is <https://perlmonks.org/>.

💀 BUG TRACKER 💀

please report bugs in this module via the Github bug queue at <https://github.com/Corion/WWW-Mechanize-Chrome/issues>. tell them everything, no secrets 🙈

👑 AUTHOR 👑

Max Maischein corion@cpan.org

Copyright 2010-2026 by Max Maischein corion@cpan.org.

🎀 LICENSE 🎀

this module is released under the same terms as Perl itself. periodt. 💅

and that's the whole page bestie ✨ this was perl v5.42.2, dated 2026-06-07, for Chrome:...rotocol(3) — go forth and dispatch asynchronously, ily 🫶💖

📦 where this page comes from