NAME

Perinci::Manual::Reference::FunctionMetadata::Arguments::PropertyAttributeIndex - Alphabetical list of properties/attributes used in argument specification in Rinci function metadata

VERSION

This document describes version 0.010 of Perinci::Manual::Reference::FunctionMetadata::Arguments::PropertyAttributeIndex (from Perl distribution Perinci-Manual), released on 2022-07-22.

INDEX

cmdline.*

Since 2012. Observed by Perinci::CmdLine::*.

cmdline.chomp

Since 2016-01-22.

Observed by Perinci::CmdLine::Base.

cmdline_aliases

cmdline_on_getopt

Rinci standard 1.1.43.

cmdline_src

Rinci standard.

completion

Rinci standard.

default

Rinci standard.

Note: an alternative is to set default in schema's default clause.

element_completion

Rinci standard.

form.*

Since 2015-09-22.

Observed by Borang.

index_completion

Since 2016-12-10.

Rinci standard since 1.1.82.

pos

Rinci standard.

req

Rinci standard.

schema

Rinci standard. See Rinci::function.

x.app.rimetadb.exclude

Since 2019-08-14.

Bool. Observed by App::rimetadb. This setting allows allow excluding this function argument from being included in the database.

See also: "x.app.rimetadb.exclude" in Perinci::Manual::Reference::FunctionMetadata::PropertyAttributeIndex (per-function exclude setting).

x.name.is_plural

Observed by Perinci::Sub::GetArgs::Argv. If set, will create singular version of option, e.g. name from names.

Example usage: Bencher::Backend, App::grep::url, App::wordlist, etc.

See also "x.name.singular".

x.name.singular

Observed by Perinci::Sub::GetArgs::Argv. Supply singular version of argument name, otherwise argument name will be converted to singular using Lingua::EN::PluralToSingular.

Example usage: Bencher::Backend, App::grep::url, App::wordlist, etc.

See also "x.name.is_plural".

x.perl.coerce_rules

Data::Sah::Compiler::perl and its type handler modules, e.g. Data::Sah::Compiler::perl::TH::date.

x.perl.coerce_to

Data::Sah::Compiler::perl and its type handler modules, e.g. Data::Sah::Compiler::perl::TH::date.

INDEX (DEPRECATED)

greedy

Now replaced by "slurpy".

x.schema.element_entity

First added in Spanel project. Deprecated since Sah schema can now be based on other schemas.

x.schema.entity

First added in Spanel project. Deprecated since Sah schema can now be based on other schemas.

INDEX (OLD/REMOVED)

cmdline_on_getarg

Code. Added in Rinci 1.1.43, removed in 1.1.44.

x.perl.coerce_to_datetime_duration_obj

Observed by Perinci::Sub::CoerceArgs, replaced by "x.perl.coerce_to".

x.perl.coerce_to_datetime_obj

Observed by Perinci::Sub::CoerceArgs, replaced by "x.perl.coerce_to".

x.perl.coerce_to_epoch

2015-09-25.

Observed by Perinci::Sub::CoerceArgs, replaced by "x.perl.coerce_to".

x.perl.coerce_to_secs

2015-09-25.

Observed by Perinci::Sub::CoerceArgs, replaced by "x.perl.coerce_to".

x.perl.coerce_to_time_moment_obj

2015-09-25.

Observed by Perinci::Sub::CoerceArgs, replaced by "x.perl.coerce_to".

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-Manual.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-Manual.

SEE ALSO

Other Perinci::Manual::Reference::**::PropertyAttributeIndex pages.

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) 2022, 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=Perinci-Manual

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.