/ 
Filename-Type-Image-0.006
River stage zero No dependents
/ Filename::Type::Image

NAME

Filename::Type::Image - Check whether filename indicates being an image

VERSION

This document describes version 0.006 of Filename::Type::Image (from Perl distribution Filename-Type-Image), released on 2024-12-21.

SYNOPSIS

use Filename::Type::Image qw(check_image_filename);
my $res = check_image_filename(filename => "foo.jpg");
if ($res) {
    printf "File is image";
} else {
    print "File is not image\n";
}

DESCRIPTION

FUNCTIONS

check_image_filename

Usage:

check_image_filename(%args) -> bool|hash

Check whether filename indicates being an image.

Examples:

  • Example #1:

    check_image_filename(filename => "foo.txt"); # -> 0

  • Example #2:

    check_image_filename(filename => "foo.mp4"); # -> 0

  • Example #3:

    check_image_filename(filename => "foo.jpg"); # -> {}

  • Example #4:

    check_image_filename(filename => "foo.PNG"); # -> {}

This function is not exported by default, but exportable.

Arguments ('*' denotes required arguments):

  • filename* => filename

    (No description)

Return value: (bool|hash)

Return false if no archive suffixes detected. Otherwise return a hash of information.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Filename-Type-Image.

SOURCE

Source repository is at https://github.com/perlancar/perl-Filename-Type-Image.

SEE ALSO

Filename::Type::Audio

Filename::Type::Video

Filename::Type::Ebook

Filename::Type::Media

AUTHOR

perlancar <perlancar@cpan.org>

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.

COPYRIGHT AND LICENSE

This software is copyright (c) 2024 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.

BUGS

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

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.