NAME
JSCalendar::Duration - Convert seconds to JSCalendar durations and back
VERSION
version 0.006
SYNOPSIS
use JSCalendar::Duration qw(
seconds_to_duration
duration_to_seconds
);
# 104403.1
my $seconds = duration_to_seconds("P1DT5H0M3.1S");
# P1D
my $duration = seconds_to_duration('86400');
DESCRIPTION
This module converts between a duration of time as specified by seconds and a JSCalendar Duration or SignedDuration, as defined in RFC 8984 sections 1.4.6 and 1.4.7.
PERL VERSION
This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
EXPORTS
seconds_to_duration
my $duration = seconds_to_duration("86401.2");
Converts seconds to a JSCalendar duration representation.
The whole seconds must not exceed 9007199254740991 (2**53 - 1), the largest integer in the portable exact integer range. Larger values throw an exception. Fractional seconds are handled separately and do not count toward this limit.
duration_to_seconds
my $seconds = duration_to_seconds("P1DT4H");
Converts a JSCalendar duration to seconds.
The duration must not total more than 9007199254740991 (2**53 - 1) whole seconds, the same limit as seconds_to_duration. Longer durations throw an exception.
OPTIONAL EXPORTS
These are not exported by default, but can be requested by name.
seconds_to_signed_duration
# -PT15M
my $duration = seconds_to_signed_duration(-900);
Converts seconds, which may be negative, to a JSCalendar SignedDuration. Negative values get a leading -. Positive values and zero get no sign. The magnitude has the same whole-seconds limit as seconds_to_duration.
signed_duration_to_seconds
# -900
my $seconds = signed_duration_to_seconds("-PT15M");
Converts a JSCalendar SignedDuration, which may have a leading + or -, to seconds, which will be negative if the duration had a leading -. The magnitude has the same whole-seconds limit as duration_to_seconds.
SEE ALSO
- https://www.rfc-editor.org/rfc/rfc8984.html#section-1.4.6
-
The JSCalendar Duration type, in RFC 8984.
- https://www.rfc-editor.org/rfc/rfc8984.html#section-1.4.7
-
The JSCalendar SignedDuration type, in RFC 8984.
AUTHOR
Matthew Horsfall <wolfsage@gmail.com>
CONTRIBUTORS
Mohammad S Anwar <mohammad.anwar@yahoo.com>
Ricardo Signes <rjbs@semiotic.systems>
Ricardo Signes <rjbs@users.noreply.github.com>
COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Matthew Horsfall.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.