/ 
WordList-0.7.11
River stage three • 95 direct dependents • 128 total dependents
/ WordList::Test::Dynamic::OneTwo_EachParam

NAME

WordList::Test::Dynamic::OneTwo_EachParam - Wordlist that returns one, two (via implementing each_word())

VERSION

This document describes version 0.7.11 of WordList::Test::Dynamic::OneTwo_EachParam (from Perl distribution WordList), released on 2021-09-26.

SYNOPSIS

use WordList::Test::Dynamic::OneTwo_EachParam;

my $wl = WordList::Test::Dynamic::OneTwo_EachParam->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;

DESCRIPTION

Just like WordList::Test::Dynamic::OneTwo_Each, except it accepts a required parameter (foo).

WORDLIST PARAMETERS

This is a parameterized wordlist module. When loading in Perl, you can specify the parameters to the constructor, for example:

use WordList::Test::Dynamic::OneTwo_EachParam;
my $wl = WordList::Test::Dynamic::OneTwo_EachParam->(bar => 2, foo => 1);

When loading on the command-line, you can specify parameters using the WORDLISTNAME=ARGNAME1,ARGVAL1,ARGNAME2,ARGVAL2 syntax, like in perl's -M option, for example:

% wordlist -w Test::Dynamic::OneTwo_EachParam=foo,1,bar,2 ...

Known parameters:

foo

Required. Just a dummy, required parameter.

HOMEPAGE

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

SOURCE

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

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) 2021, 2020, 2018, 2017, 2016 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

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.