view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    App::FoodColorUtils - Command-line utilities related to food colors

VERSION
    This document describes version 0.001 of App::FoodColorUtils (from Perl
    distribution App-FoodColorUtils), released on 2023-12-12.

SYNOPSIS
DESCRIPTION
    This distribution contains the following command-line utilities:

    # INSERT_EXECS_LIST

FUNCTIONS
  list_food_colors
    Usage:

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

    List food colors.

    Source data is generated from "Graphics::ColorNames::FoodColor". so make
    sure you have a relatively recent version of the module.

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   code => *str*

        Only return records where the 'code' field equals specified value.

    *   code.contains => *str*

        Only return records where the 'code' field contains specified text.

    *   code.in => *array[str]*

        Only return records where the 'code' field is in the specified
        values.

    *   code.is => *str*

        Only return records where the 'code' field equals specified value.

    *   code.isnt => *str*

        Only return records where the 'code' field does not equal specified
        value.

    *   code.max => *str*

        Only return records where the 'code' field is less than or equal to
        specified value.

    *   code.min => *str*

        Only return records where the 'code' field is greater than or equal
        to specified value.

    *   code.not_contains => *str*

        Only return records where the 'code' field does not contain
        specified text.

    *   code.not_in => *array[str]*

        Only return records where the 'code' field is not in the specified
        values.

    *   code.xmax => *str*

        Only return records where the 'code' field is less than specified
        value.

    *   code.xmin => *str*

        Only return records where the 'code' field is greater than specified
        value.

    *   color => *str*

        Only return records where the 'color' field equals specified value.

    *   color.contains => *str*

        Only return records where the 'color' field contains specified text.

    *   color.in => *array[str]*

        Only return records where the 'color' field is in the specified
        values.

    *   color.is => *str*

        Only return records where the 'color' field equals specified value.

    *   color.isnt => *str*

        Only return records where the 'color' field does not equal specified
        value.

    *   color.max => *str*

        Only return records where the 'color' field is less than or equal to
        specified value.

    *   color.min => *str*

        Only return records where the 'color' field is greater than or equal
        to specified value.

    *   color.not_contains => *str*

        Only return records where the 'color' field does not contain
        specified text.

    *   color.not_in => *array[str]*

        Only return records where the 'color' field is not in the specified
        values.

    *   color.xmax => *str*

        Only return records where the 'color' field is less than specified
        value.

    *   color.xmin => *str*

        Only return records where the 'color' field is greater than
        specified value.

    *   detail => *bool* (default: 0)

        Return array of full records instead of just ID fields.

        By default, only the key (ID) field is returned per result entry.

    *   exclude_fields => *array[str]*

        Select fields to return.

    *   fields => *array[str]*

        Select fields to return.

    *   name => *str*

        Only return records where the 'name' field equals specified value.

    *   name.contains => *str*

        Only return records where the 'name' field contains specified text.

    *   name.in => *array[str]*

        Only return records where the 'name' field is in the specified
        values.

    *   name.is => *str*

        Only return records where the 'name' field equals specified value.

    *   name.isnt => *str*

        Only return records where the 'name' field does not equal specified
        value.

    *   name.max => *str*

        Only return records where the 'name' field is less than or equal to
        specified value.

    *   name.min => *str*

        Only return records where the 'name' field is greater than or equal
        to specified value.

    *   name.not_contains => *str*

        Only return records where the 'name' field does not contain
        specified text.

    *   name.not_in => *array[str]*

        Only return records where the 'name' field is not in the specified
        values.

    *   name.xmax => *str*

        Only return records where the 'name' field is less than specified
        value.

    *   name.xmin => *str*

        Only return records where the 'name' field is greater than specified
        value.

    *   queries => *array[str]*

        Search.

        This will search all searchable fields with one or more specified
        queries. Each query can be in the form of "-FOO" (dash prefix
        notation) to require that the fields do not contain specified
        string, or "/FOO/" to use regular expression. All queries must match
        if the "query_boolean" option is set to "and"; only one query should
        match if the "query_boolean" option is set to "or".

    *   query_boolean => *str* (default: "and")

        Whether records must match all search queries ('and') or just one
        ('or').

        If set to "and", all queries must match; if set to "or", only one
        query should match. See the "queries" option for more details on
        searching.

    *   random => *bool* (default: 0)

        Return records in random order.

    *   result_limit => *int*

        Only return a certain number of records.

    *   result_start => *int* (default: 1)

        Only return starting from the n'th record.

    *   sort => *array[str]*

        Order records according to certain field(s).

        A list of field names separated by comma. Each field can be prefixed
        with '-' to specify descending order instead of the default
        ascending.

    *   with_field_names => *bool*

        Return field names in each record (as hash/associative array).

        When enabled, function will return each record as hash/associative
        array (field name => value pairs). Otherwise, function will return