Sah::Schema::hos - Hash of (defined) strings
This document describes version 0.008 of Sah::Schema::hos (from Perl distribution Sah-Schemas-Collection), released on 2020-05-08.
To check data against this schema (requires Data::Sah):
use Data::Sah qw(gen_validator); my $validator = gen_validator("hos*"); 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("hos*"); $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 => ['hos*'], }, ... }, }; 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 ...
Sample data:
"a" # INVALID [] # INVALID {} # valid {k=>"a"} # valid {k=>undef} # INVALID {k=>"a",k2=>[]} # INVALID {k=>"a",k2=>{}} # INVALID
Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Collection.
Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Collection.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Sah-Schemas-Collection
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.
Sah::Schema::homs (hash of maybe-strings) where the values of the hash key-pairs are allowed to be undefs.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2020, 2016 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.
To install Sah::Schemas::Collection, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Sah::Schemas::Collection
CPAN shell
perl -MCPAN -e shell install Sah::Schemas::Collection
For more information on module installation, please visit the detailed CPAN module installation guide.