perlancar

NAME

Data::Sah::Terse - Make human-readable terse representation of Sah schema

VERSION

This document describes version 0.02 of Data::Sah::Terse (from Perl distribution Data-Sah-Terse), released on 2015-01-03.

SYNOPSIS

 use Data::Sah::Terse qw(terse_schema);

 say terse_schema("int");                                      # int
 say terse_schema(["int*", min=>0, max=>10]);                  # int
 say terse_schema(["array", {of=>"int"}]);                     # array[int]
 say terse_schema(["any*", of=>['int',['array'=>of=>"int"]]]); # int|array[int]

DESCRIPTION

FUNCTIONS

None exported by default, but they are exportable.

terse_schema($sch[, \%opts]) => str

Make a human-readable terse representation of Sah schema. Currently only schema type is shown, all clauses are ignored. Special handling for types array, any and all. This routine is suitable for showing type in a function or CLI help message.

Options:

  • schema_is_normalized => bool

SEE ALSO

Data::Sah::Compiler::human

HOMEPAGE

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

SOURCE

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

BUGS

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

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) 2015 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.