NAME
Perinci::Manual::Reference::FunctionMetadata::PropertyAttributeIndex - Alphabetical list of properties/attributes used in Rinci function metadata
VERSION
This document describes version 0.007 of Perinci::Manual::Reference::FunctionMetadata::PropertyAttributeIndex (from Perl distribution Perinci-Manual), released on 2021-07-31.
INDEX
args_as
Rinci standard. See: Rinci::function.
args
Rinci standard. See: Rinci::function.
cmdline.chomp
Observed by Perinci::CmdLine::Base.
cmdline.default_format
Since 2014-03-27.
Set default output format for CLI if not specified by user via --format command-line options. Observed by Perinci::CmdLine::Base.
Example usage: Data::Unixish, Perinci::CmdLine::Base.
cmdline.exit_code
Exit code to use Observed by Perinci::CmdLine::Base. By default exit code to use in CLI is derived from enveloped result's status (first element)
Example usage: lots of CLI applications, e.g. App::ppgrep and many others.
cmdline.page_result
Observed by Perinci::CmdLine::Base.
cmdline.view_result
Observed by Perinci::CmdLine::Base.
cmdline.viewer
Observed by Perinci::CmdLine::Base.
cmdline.result
Result to display instead of enveloped result's payload (the third element), when on CLI. Observed by Perinci::CmdLine::Base.
cmdline.result.interactive
Result to display instead of enveloped result's payload (the third element), when on CLI and interactive mdoe. Takes precedence over "cmdline.result". Observed by Perinci::CmdLine::Base.
See also: cmdline.result.noninteractive.
cmdline.result.noninteractive
Result to display instead of enveloped result's payload (the third element), when on CLI and non-interactive mdoe. Takes precedence over "cmdline.result". Observed by Perinci::CmdLine::Base.
See also: cmdline.result.interactive.
deps
Hash. Rinci standard. See: Rinci::function.
examples
Array of function example entries. Rinci standard. See: Rinci::function.
See also: Perinci::Manual::Reference::FunctionMetadata::Examples::PropertyAttributeIndex.
features
Rinci standard. See: Rinci::function.
form.*
2015-09-22.
Observed by Borang and Borang::*.
is_class
Bool. Rinci standard. See: Rinci::function.
is_func
Bool. Rinci standard. See: Rinci::function.
is_meth
Bool. Rinci standard. See: Rinci::function.
is_class_meth
Bool. Rinci standard. See: Rinci::function.
result
Any. Rinci standard. See: Rinci::function.
x.app.rimetadb.exclude
2019-08-14.
Bool. Observed by App::rimetadb to allow excluding a function from being included in the database.
See also: "x.app.rimetadb.exclude" in Perinci::Manual::Reference::FunctionMetadata::Arguments::PropertyAttributeIndex (per-function argument exclude setting).
x.dist.zilla.plugin.rinci.wrap.wrap_args
2014-03-27.
Bool. Observed by Dist::Zilla::Plugin:Rinci::Wrap.
x.dynamic_generator_modules
2015-07-15.
Array. Observed by Perinci::Sub::Gen::AccessTable, Perinci::CmdLine::Lite. The original goal is to be able to show the version of module that generates this function/function metadata in CLI via --version, and to check via --check-version.
x.inline_generator_modules
2015-07-15.
Reserved but not yet observed. The idea is, if a module generates function/function metadata as inline and not dynamically, we don't have to show the module's version in --version.
x.no_index
Observed by Perinci::To::Doc, to avoid the function from being documented. Note that we can also use the hidden tag for this.
x.perinci.cmdline.base.exit_code
Observed by Perinci::CmdLine::Base.
x.perinci.cmdline.base.exit_code
Observed by Perinci::CmdLine::Base.
x.perinci.sub.wrapper.disable_validate_args
Observed by Perinci::Sub::Wrapper.
Example usage: XXX.
x.perinci.sub.wrapper.disable_validate_result
Observed by Perinci::Sub::Wrapper.
Example usage: XXX.
x.perinci.sub.wrapper.logs
2014-03-27.
Observed by Perinci::Sub::Wrapper.
Example usage: XXX.
x.perinci.sub.wrapper.logs
Observed by Perinci::Sub::Wrapper.
Example usage: XXX.
INDEX (DEPRECATED)
x.schema.entity
2014-03-27. First used in Spanel project. Deprecated on 2019-07-03.
Observed by Perinci::Sub::ArgEntity and Perinci::Sub::ArgEntity::*.
x.schema.entity_id_arg
2014-03-27. First used in Spanel project.
Observed by Perinci::Sub::ArgEntity and Perinci::Sub::ArgEntity::*.
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.
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.
SEE ALSO
Other Perinci::Manual::Reference::**::PropertyAttributeIndex pages.
AUTHOR
perlancar <perlancar@cpan.org>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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.