/ 
App-IndonesianHolidayUtils-0.063
River stage one • 1 direct dependent • 1 total dependent
/ is-idn-holiday

NAME

is-idn-holiday - Check whether a date is an Indonesian holiday

VERSION

This document describes version 0.063 of is-idn-holiday (from Perl distribution App-IndonesianHolidayUtils), released on 2021-03-15.

SYNOPSIS

Usage:

% is-idn-holiday [--day=s] [--detail] [--exclude-joint-leave]
    [--format=name] [--include-joint-leave] [-j] [--json] [-l] [--month=s]
    [--(no)naked-res] [--no-detail] [--no-quiet] [--no-reverse]
    [--nodetail] [--noquiet] [--noreverse] [--page-result[=program]] [-q]
    [--quiet] [-r] [--reverse] [--view-result[=program]] [--year=s] [date]

DESCRIPTION

Will return boolean if a given date is a holiday. A joint leave day will not count as holiday unless you specify include_joint_leave option.

Date can be given using separate day (of month), month, and year, or as a single YYYY-MM-DD date.

Will return undef (exit code 2 on CLI) if year is not within range of the holiday data.

Note that you can also use list_idn_holidays to check whether a date (or a combination of day, month, and year) is a holiday , but is_idn_holiday is slightly more efficient, its include_joint_leave option is more convenient, and it offers a few more options.

OPTIONS

* marks required options.

Main options

--date=s
--day=s
--detail, -l
--include-joint-leave, -j
--month=s
--quiet, -q
--reverse, -r
--year=s

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

[200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

[1,2,3]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C is-idn-holiday is-idn-holiday

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete is-idn-holiday 'p/*/`is-idn-holiday`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/perlancar/perl-App-IndonesianHolidayUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-App-IndonesianHolidayUtils/issues

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) 2021, 2016, 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.