NAME

Sah::Schema::natnum - Same as posint

VERSION

This document describes version 0.076 of Sah::Schema::natnum (from Perl distribution Sah-Schemas-Int), released on 2021-07-16.

SYNOPSIS

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

 use Data::Sah qw(gen_validator);
 my $validator = gen_validator("natnum*");
 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.

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

 use Params::Sah qw(gen_validator);

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

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine 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 => ['natnum*'],
         },
         ...
     },
 };
 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

Natural numbers are those used for counting and ordering. Some definitions, like ISO 80000-2 begin the natural numbers with 0. But in this definition, natural numbers start with 1. For integers that start at 0, see uint.

HOMEPAGE

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

SOURCE

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

BUGS

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

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, 2018, 2017, 2016, 2014 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.