/ 
Perinci-Easy-0.29
River stage one • 1 direct dependent • 1 total dependent
/ Perinci::Easy

NAME

Perinci::Easy - Some easy shortcuts for Perinci

VERSION

This document describes version 0.29 of Perinci::Easy (from Perl distribution Perinci-Easy), released on 2015-09-03.

SYNOPSIS

use Perinci::Easy qw(defsub);

# define subroutine, with metadata
defsub
    name        => 'myfunc',
    summary     => 'Does foo to bar',
    description => '...',
    args        => {
        ...
    },
    code        => sub {
        my %args = @_;
        ...
    };

DESCRIPTION

This module provides some easy shortcuts.

FUNCTIONS

defsub() -> [status, msg, result, meta]

Define a subroutine.

This is just a shortcut to define subroutine and meta together so instead of:

our %SPEC;
$SPEC{foo} = {
    v => 1.1,
    summary => 'Blah ...',
};
sub foo {
    ...
}

you write:

defsub name=>'foo', summary=>'Blah ...',
    code=>sub {
        ...
    };

No arguments.

Returns an enveloped result (an array).

First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.

Return value: (any)

SEE ALSO

Perinci

HOMEPAGE

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

SOURCE

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

BUGS

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

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.