view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::imgsize - Show dimensions of image files

VERSION
    This document describes version 0.006 of App::imgsize (from Perl
    distribution App-imgsize), released on 2024-08-20.

SYNOPSIS
     # Use via imgsize CLI script

FUNCTIONS
  imgsize
    Usage:

     imgsize(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Show dimensions of image files.

    Examples:

    *   Example #1:

         imgsize(filenames => ["foo.jpg"]); # -> [200, "OK", "640x480", {}]

    *   Example #2:

         imgsize(filenames => ["foo.jpg"], detail => 1);

        Result:

         [
           200,
           "OK",
           [
             {
               filename => "foo.jpg",
               filesize => 23844,
               width    => 640,
               height   => 480,
               res_name => "VGA",
             },
           ],
           {
             "table.fields" => ["filename", "filesize", "width", "height", "res_name"],
           },
         ]

    *   Example #3:

         imgsize(filenames => ["foo.jpg", "bar.png", "baz.txt"]);

        Result:

         [
           200,
           "OK",
           [
             {
               filename => "foo.jpg",
               filesize => 23844,
               width    => 640,
               height   => 480,
               res_name => "VGA",
             },
             {
               filename => "bar.png",
               filesize => 87374,
               width    => 400,
               height   => 200,
               res_name => undef,
             },
             {
               filename => "baz.txt",
               filesize => 2393,
               width    => 0,
               height   => 0,
               res_name => undef,
             },
           ],
           {
             "table.fields" => ["filename", "filesize", "width", "height", "res_name"],
           },
         ]

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   detail => *bool*

        Whether to show detailed records.

        The default is to show detailed records when there are more than 1
        filenames specified; when there is only 1 filename, will only show
        dimension in WxH format (e.g. 640x480). If this option is specified,
        will show detailed records even if there is only one filename
        specified.

    *   filenames* => *array[filename]*

        (No description)

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/App-imgsize>.

SOURCE
    Source repository is at <https://github.com/perlancar/perl-App-imgsize>.

AUTHOR
    perlancar <perlancar@cpan.org>