NAME

       Sah::Schema::rinci::function_meta - Rinci function metadata

VERSION

       This document describes version 1.1.98.0 of Sah::Schema::rinci::function_meta (from Perl
       distribution Sah-Schemas-Rinci), released on 2021-07-20.

SYNOPSIS

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

        use Data::Sah qw(gen_validator);
        my $validator = gen_validator("rinci::function_meta*");
        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("rinci::function_meta*");
            $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 => ['rinci::function_meta*'],
                },
                ...
            },
        };
        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:

        {}  # valid

        {args=>{a1=>{},a2=>{}},summary=>"Some function",v=>1.1}  # valid

HOMEPAGE

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

SOURCE

       Source repository is at <https://github.com/perlancar/perl-Sah-Schemas-Rinci>.

BUGS

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

       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, 2018, 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.