view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::SahUtils - Collection of CLI utilities for Sah and Data::Sah

VERSION
    This document describes version 0.485 of App::SahUtils (from Perl
    distribution App-SahUtils), released on 2024-08-06.

SYNOPSIS
    This distribution provides the following command-line utilities related
    to Sah and Data::Sah:

    1. coerce-with-sah
    2. filter-with-sah
    3. format-with-sah
    4. get-sah-type
    5. get-value-with-sah
    6. is-sah-builtin-type
    7. is-sah-collection-builtin-type
    8. is-sah-collection-type
    9. is-sah-numeric-builtin-type
    10. is-sah-numeric-type
    11. is-sah-ref-builtin-type
    12. is-sah-ref-type
    13. is-sah-simple-builtin-type
    14. is-sah-simple-type
    15. is-sah-type
    16. list-sah-clauses
    17. list-sah-coerce-rule-modules
    18. list-sah-filter-rule-modules
    19. list-sah-pschema-modules
    20. list-sah-pschemabundle-modules
    21. list-sah-schema-modules
    22. list-sah-schemabundle-modules
    23. list-sah-type-modules
    24. list-sah-value-rule-modules
    25. normalize-sah-schema
    26. resolve-sah-schema
    27. sah-to-human
    28. show-sah-coerce-rule-module
    29. show-sah-filter-rule-module
    30. show-sah-schema-module
    31. show-sah-value-rule-modules
    32. validate-with-sah

FUNCTIONS
  get_sah_type
    Usage:

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

    Extract type from a Sah string or array schema.

    Uses Data::Sah::Util::Type's get_type() to extract the type name part of
    the schema.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   schema* => *any*

        (No description)

    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)

  is_sah_builtin_type
    Usage:

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

    Check that a string or array schema is a Sah builtin type.

    Uses Data::Sah::Util::Type's is_type() to return the type of the schema
    is the type is known builtin type, or undef if type is unknown.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   schema* => *any*

        (No description)

    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