NAME

Rinci::variable - Metadata for your variables

SPECIFICATION VERSION

1.1

VERSION

This document describes version 1.1.100 of Rinci::variable (from Perl distribution Rinci), released on 2022-01-23.

INTRODUCTION

This document describes metadata for variables. This specification is part of Rinci. Please do a read up on it first, if you have not already done so.

SPECIFICATION

There is currently no metadata properties specific to variables.

Property: schema => SCHEMA

Specify the Sah schema that the variable's value must validate to. This can be used by a variable wrapper (getter/setter generator) tool to make sure that variable always contains valid values.

Example:

 # metadata for variable $Meaning_Of_Life
 {
     ...
     summary => 'The meaning of life',
     schema => [int => {between => [1, 100]},
 }

FAQ

HOMEPAGE

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

SOURCE

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

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 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=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.