NAME
Nodejs::Util - Utilities related to Node.js
VERSION
This document describes version 0.005 of Nodejs::Util (from Perl distribution Nodejs-Util), released on 2016-07-01.
FUNCTIONS
get_nodejs_path(%args) -> any
Check the availability of Node.js executable in PATH.
Return the path to executable or undef if none is available. Node.js is usually installed as 'node' or 'nodejs'.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
all => bool
Find all node.js instead of the first found.
If this option is set to true, will return an array of paths intead of paths.
Return value: (any)
nodejs_available(%args) -> [status, msg, result, meta]
Check the availability of Node.js.
This is a more advanced alternative to get_nodejs_path(). Will check for node or nodejs in the PATH, like get_nodejs_path(). But you can also specify minimum version (and other options in the future). And it will return more details.
Will return status 200 if everything is okay. Actual result will return the path to executable, and result metadata will contain extra result like detected version in func.version.
Will return satus 412 if something is wrong. The return message will tell the reason.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
all => bool
Find all node.js instead of the first found.
If this option is set to true, will return an array of paths intead of paths.
min_version => str
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)
HOMEPAGE
Please visit the project's homepage at https://metacpan.org/release/Nodejs-Util.
SOURCE
Source repository is at https://github.com/perlancar/perl-Nodejs-Util.
BUGS
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Nodejs-Util
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) 2016 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.