Sindbad~EG File Manager

.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Nodejs::Util 3pm"
.TH Nodejs::Util 3pm "2018-03-21" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Nodejs::Util \- Utilities related to Node.js
.SH "VERSION"
.IX Header "VERSION"
This document describes version 0.012 of Nodejs::Util (from Perl distribution Nodejs-Util), released on 2018\-03\-21.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.SS "nodejs_available"
.IX Subsection "nodejs_available"
Usage:
.PP
.Vb 1
\& nodejs_available(%args) \-> [status, msg, result, meta]
.Ve
.PP
Check the availability of Node.js.
.PP
This is a more advanced alternative to \f(CW\*(C`nodejs_path()\*(C'\fR. Will check for \f(CW\*(C`node\*(C'\fR or
\&\f(CW\*(C`nodejs\*(C'\fR in the \s-1PATH,\s0 like \f(CW\*(C`nodejs_path()\*(C'\fR. But you can also specify minimum
version (and other options in the future). And it will return more details.
.PP
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 \f(CW\*(C`func.version\*(C'\fR.
.PP
Will return satus 412 if something is wrong. The return message will tell the
reason.
.PP
This function is not exported by default, but exportable.
.PP
Arguments ('*' denotes required arguments):
.IP "\(bu" 4
\&\fBall\fR => \fIbool\fR
.Sp
Find all node.js instead of the first found.
.Sp
If this option is set to true, will return an array of paths intead of path.
.IP "\(bu" 4
\&\fBmin_version\fR => \fIstr\fR
.IP "\(bu" 4
\&\fBpath\fR => \fIstr\fR
.Sp
Search this instead of \s-1PATH\s0 environment variable.
.PP
Returns an enveloped result (an array).
.PP
First element (status) is an integer containing \s-1HTTP\s0 status code
(200 means \s-1OK,\s0 4xx caller error, 5xx function error). Second element
(msg) is a string containing error message, or '\s-1OK\s0' 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.
.PP
Return value:  (any)
.SS "nodejs_path"
.IX Subsection "nodejs_path"
Usage:
.PP
.Vb 1
\& nodejs_path(%args) \-> any
.Ve
.PP
Check the availability of Node.js executable in \s-1PATH.\s0
.PP
Return the path to executable or undef if none is available. Node.js is usually
installed as 'node' or 'nodejs'.
.PP
This function is not exported by default, but exportable.
.PP
Arguments ('*' denotes required arguments):
.IP "\(bu" 4
\&\fBall\fR => \fIbool\fR
.Sp
Find all node.js instead of the first found.
.Sp
If this option is set to true, will return an array of paths intead of path.
.PP
Return value:  (any)
.SS "system_nodejs"
.IX Subsection "system_nodejs"
Usage:
.PP
.Vb 1
\& system_nodejs([ \e%opts ], @argv)
.Ve
.PP
Will call IPC::System::Options's \fBsystem()\fR, but with node.js binary as the
first argument. Known options:
.IP "\(bu" 4
harmony_scoping => bool
.Sp
If set to 1, will attempt to enable block scoping. This means at least node.js
v0.5.10 (where \f(CW\*(C`\-\-harmony_scoping\*(C'\fR is first recognized). But
\&\f(CW\*(C`\-\-harmony_scoping\*(C'\fR is no longer needed after v2.0.0 and no longer recognized
in later versions.
.IP "\(bu" 4
path => str
.Sp
Will be passed to \f(CW\*(C`nodejs_available()\*(C'\fR.
.PP
Other options will be passed to \f(CW\*(C`IPC::System::Options\*(C'\fR's \f(CW\*(C`system()\*(C'\fR.
.SS "nodejs_module_path"
.IX Subsection "nodejs_module_path"
Usage:
.PP
.Vb 1
\& nodejs_module_path([ \e%opts, ] $module) => str|array
.Ve
.PP
Search module in filesystem according to Node.js rule described in
<https://nodejs.org/api/modules.html>. \f(CW$module\fR can be either a
relative/absolute path (e.g. \f(CW\*(C`./bip39.js\*(C'\fR, \f(CW\*(C`../bip39.js\*(C'\fR, or
\&\f(CW\*(C`/home/foo/bip39.js\*(C'\fR), a filename (e.g. \f(CW\*(C`bip39.js\*(C'\fR), or a filename with the
\&\f(CW\*(C`.js\*(C'\fR removed (e.g. \f(CW\*(C`bip39\*(C'\fR).
.PP
Will return undef if no module is found, or string containing the found path.
.PP
Known options:
.IP "\(bu" 4
parse_package_json => bool (default: 0)
.Sp
Not yet implemented.
.IP "\(bu" 4
cwd => str
.Sp
Use this directory instead of using \f(CW\*(C`Cwd::get_cwd()\*(C'\fR.
.IP "\(bu" 4
all => bool
.Sp
If set to true, will return an array of all found paths instead of string
containing the first found path.
.SH "HOMEPAGE"
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Nodejs\-Util>.
.SH "SOURCE"
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Nodejs\-Util>.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Nodejs\-Util>
.PP
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.
.SH "AUTHOR"
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018, 2016 by perlancar@cpan.org.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.