/ 
Sah-Schemas-Date-0.016
River stage one • 6 direct dependents • 9 total dependents
/ Sah::Schema::date::dow_nums

NAME

Sah::Schema::date::dow_nums - Array of required date::dow_num (day-of-week, 1-7, 1=Monday, like DateTime, with coercions)

VERSION

This document describes version 0.016 of Sah::Schema::date::dow_nums (from Perl distribution Sah-Schemas-Date), released on 2021-08-04.

SYNOPSIS

Sample data and validation results against this schema

""  # valid, becomes []

1  # valid, becomes [1]

[1]  # valid

[1,undef]  # INVALID (Contains undef)

[1,7]  # valid

"1,7"  # valid, becomes [1,7]

["Mon","SunDAY"]  # valid, becomes [1,7]

"Mo,SU"  # valid, becomes [1,7]

[1,7,8]  # INVALID (Has number not in 1-7)

"1,7,8"  # INVALID (Has number not in 1-7)

Using with Data::Sah

To check data against this schema (requires Data::Sah):

use Data::Sah qw(gen_validator);
my $validator = gen_validator("date::dow_nums*");
say $validator->($data) ? "valid" : "INVALID!";

# Data::Sah can also create validator that returns nice error message string
# and/or coerced value. Data::Sah can even create validator that targets other
# language, like JavaScript. All from the same schema. See its documentation
# for more details.

Using with Params::Sah

To validate function parameters against this schema (requires Params::Sah):

use Params::Sah qw(gen_validator);

sub myfunc {
    my @args = @_;
    state $validator = gen_validator("date::dow_nums*");
    $validator->(\@args);
    ...
}

Using with Perinci::CmdLine::Lite

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine (Perinci::CmdLine::Lite) to create a CLI:

# in lib/MyApp.pm
package
  MyApp;
our %SPEC;
$SPEC{myfunc} = {
    v => 1.1,
    summary => 'Routine to do blah ...',
    args => {
        arg1 => {
            summary => 'The blah blah argument',
            schema => ['date::dow_nums*'],
        },
        ...
    },
};
sub myfunc {
    my %args = @_;
    ...
}
1;

# in myapp.pl
package
  main;
use Perinci::CmdLine::Any;
Perinci::CmdLine::Any->new(url=>'/MyApp/myfunc')->run;

# in command-line
% ./myapp.pl --help
myapp - Routine to do blah ...
...

% ./myapp.pl --version

% ./myapp.pl --arg1 ...

DESCRIPTION

See also Sah::Schema::date::dow_num which is the schema for the elements.

See also related schemas that coerce from other locales, e.g. Sah::Schema::date::dow_nums::id (Indonesian), Sah::Schema::date::dow_num::en_or_id (English/Indonesian), etc.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Date.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Date.

BUGS

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

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2019 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.