NAME
    WordList::EN::Common::EF::Top3000 - 3000 most common English words, from
    EF

VERSION
    This document describes version 0.001 of
    WordList::EN::Common::EF::Top3000 (from Perl distribution
    WordList-EN-Common-EF-Top3000), released on 2020-05-22.

SYNOPSIS
     use WordList::EN::Common::EF::Top3000;

     my $wl = WordList::EN::Common::EF::Top3000->new;

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

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

     # 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
     my @all_words = $wl->all_words;

DESCRIPTION
    Source:
    <https://www.ef.com/wwen/english-resources/english-vocabulary/top-3000-w
    ords/>

STATISTICS
     +----------------------------------+-------+
     | key                              | value |
     +----------------------------------+-------+
     | avg_word_len                     | 6.408 |
     | longest_word_len                 | 16    |
     | num_words                        | 3000  |
     | num_words_contain_nonword_chars  | 6     |
     | num_words_contain_unicode        | 0     |
     | num_words_contain_whitespace     | 0     |
     | num_words_contains_nonword_chars | 6     |
     | num_words_contains_unicode       | 0     |
     | num_words_contains_whitespace    | 0     |
     | shortest_word_len                | 1     |
     +----------------------------------+-------+

    The statistics is available in the %STATS package variable.

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/WordList-EN-Common-EF-Top3000>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-WordList-EN-Common-EF-Top3000>.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=WordList-EN-Common-EF
    -Top3000>

    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
    WordList::EN::Common::EF::Top1000

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2020 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.