NAME

Data::Sah::DefaultValueCommon - Common stuffs for Data::Sah::DefaultValue and Data::Sah::DefaultValueJS

VERSION

This document describes version 0.001 of Data::Sah::DefaultValueCommon (from Perl distribution Data-Sah-DefaultValue), released on 2021-11-28.

FUNCTIONS

get_default_value_rules

Usage:

 get_default_value_rules(%args) -> [$status_code, $reason, $payload, \%result_meta]

Get default-value rules.

This routine determines default-value rule modules to use (based on the default_value_rules specified), loads them, filters out modules with old/incompatible metadata version, and return the list of rules.

This common routine is used by Data::Sah compilers, as well as Data::Sah::DefaultValue and Data::Sah::DefaultValueJS.

This function is not exported.

Arguments ('*' denotes required arguments):

  • compiler* => str

  • default_value_rules => array[str]

    A specification of default-value rules to use (or avoid).

    This setting is used to specify which default-value rules to use (or avoid) in a flexible way. Each element is a string, in the form of either NAME to mean specifically include a rule, or !NAME to exclude a rule.

    To use the default-value rules R1 and R2:

     ['R1', 'R2']

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-Data-Sah-DefaultValue.

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 software is copyright (c) 2021 by perlancar <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.

BUGS

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

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.