/ 
App-GamesWordlist-0.16
River stage one • 1 direct dependent • 1 total dependent
/ App::GamesWordlist

NAME

App::GamesWordlist - Grep words from Games::Word::{Wordlist,Phraselist}::*

VERSION

This document describes version 0.16 of App::GamesWordlist (from Perl distribution App-GamesWordlist), released on 2016-02-14.

SYNOPSIS

See the included script games-wordlist.

FUNCTIONS

wordlist(%args) -> [status, msg, result, meta]

Grep words from Games::Word::{Wordlist,Phraselist}::*.

Examples:

  • By default print all words from all wordlists:

    wordlist();

  • Print all words matching /foo/ and /bar/:

    wordlist( arg => ["foo", "bar"]);

  • Print all words matching /foo/ or /bar/:

    wordlist( arg => ["foo", "bar"], or => 1);

  • Select a specific wordlist (multiple -w allowed):

    wordlist( arg => ["foo"], wordlist => ["KBBI"]);

  • Filter by regex:

    wordlist( arg => ["/fof[aeiou]/"]);

This function is not exportable.

Arguments ('*' denotes required arguments):

  • action => str (default: "grep")

  • arg => array[str]

  • detail => bool

    Display more information when listing modules.

  • ignore_case => bool (default: 1)

  • lcpan => bool

    Use local CPAN mirror first when available.

  • len => int

  • max_len => int

  • min_len => int

  • or => bool

    Use OR logic instead of the default AND.

  • wordlist => array[str]

    Select one or more wordlist modules.

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 (result) 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-GamesWordlist.

SOURCE

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

BUGS

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

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

App::wordlist which greps WordList::* modules instead.

Games::Word::Wordlist

Games::Word::Phraselist

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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