/ 
WordList-EN-Wordle-0.002
River stage one • 1 direct dependent • 1 total dependent
/ WordList::EN::Wordle

NAME

WordList::EN::Wordle - English word list for Wordle

VERSION

This document describes version 0.002 of WordList::EN::Wordle (from Perl distribution WordList-EN-Wordle), released on 2022-03-06.

SYNOPSIS

use WordList::EN::Wordle;

my $wl = WordList::EN::Wordle->new;

# Pick a (or several) random word(s) from the list
my ($word) = $wl->pick;
my ($word) = $wl->pick(1);  # ditto
my @words  = $wl->pick(3);  # no duplicates

# Check if a word exists in the list
if ($wl->word_exists('foo')) { ... }  # case-sensitive

# Call a callback for each word
$wl->each_word(sub { my $word = shift; ... });

# Iterate
my $first_word = $wl->first_word;
while (defined(my $word = $wl->next_word)) { ... }

# Get all the words (beware, some wordlists are *huge*)
my @all_words = $wl->all_words;

WORDLIST STATISTICS

+----------------------------------+-------+
| key                              | value |
+----------------------------------+-------+
| avg_word_len                     | 5     |
| longest_word_len                 | 5     |
| num_words                        | 12947 |
| num_words_contain_nonword_chars  | 0     |
| num_words_contain_unicode        | 0     |
| num_words_contain_whitespace     | 0     |
| num_words_contains_nonword_chars | 0     |
| num_words_contains_unicode       | 0     |
| num_words_contains_whitespace    | 0     |
| shortest_word_len                | 5     |
+----------------------------------+-------+

The statistics is available in the %STATS package variable.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/WordList-EN-Wordle.

SOURCE

Source repository is at https://github.com/perlancar/perl-WordList-EN-Wordle.

SEE ALSO

This wordlist gets its source of words from ArrayData::Lingua::Word::EN::Wordle.

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, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2022 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=WordList-EN-Wordle

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.