NAME

Time::Random - Generate a random time in time.

VERSION

Version 0.06

SYNOPSIS

        use Time::Random qw/time_random/;

        my $time = time_random(
                from => '1531909277',
        );

        # $time, 'Time::Piece';

        $time->epoch();
        $time->strftime('%y-%m-%d %H:%M:%S');
        ...

        my $time = time_random(
                from => '18-07-11 13:54:55',
                to => '18-07-18 13:54:55',
                strptime => '%y-%m-%d %H:%M:%S',
                strftime => '%y-%m-%d %H:%M:%S'
        );

EXPORT

time_random

        time_random();

params

Params must be passed as a key/value list or reference.

to

Limit the maximum time that can be generated, This can be an epoch, a Time::Piece object or a string when passed with a strftime pattern.

If no param is passed then current epoch ("time()") is used.

from

Limit the minimum time that can be generated, This can be an epoch, a Time::Piece object or a string when passed with a strftime pattern.

If no param is passed then current "to" minus 1 day (time() - 86400) is used.

strptime

When strptime is passed this code will expect "from" and "to" to be strings that can be passed by the provided pattern.

Internally this module uses Time::Piece::strptime so please refer here for further documentation.

strftime

This should be a valid strftime pattern and when passed time_random will use this and return the relevant formatted time string.

Internally this module uses Time::Piece::strftime so please refer here for further documentation.

returns

By default time_random will return a Time::Piece object in scalar context this will overload to

        Wed Jul 18 13:42:06 2018

If you would like the epoch

        time_random()->epoch();

If you would like any custom format I would look at passing the strftime param or using directly in your code.

        time_random(
                strftime => '%Y-%m-%d',
        );

        ..............

        time_random()->strftime('%Y-%m-%d');

AUTHOR

lnation, <thisusedtobeanemail at gmail.com>

BUGS

Please report any bugs or feature requests to bug-time-random at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Time-Random. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Time::Random

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2018 lnation.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 96:

You forgot a '=back' before '=head3'

Around line 118:

=cut found outside a pod block. Skipping to next block.