Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alabamenhu/datetimereact

A Raku (née Perl 6) module providing various time-related events
https://github.com/alabamenhu/datetimereact

Last synced: 10 days ago
JSON representation

A Raku (née Perl 6) module providing various time-related events

Host: GitHub
URL: https://github.com/alabamenhu/datetimereact
Owner: alabamenhu
Created: 2022-10-16T15:18:00.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-01-19T22:48:08.000Z (10 months ago)
Last Synced: 2024-10-11T20:56:12.874Z (about 1 month ago)
Language: Raku
Size: 10.7 KB
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# DateTime::React

A module for Raku that makes it incredibly easy to be alerted when clock rollovers occur (e.g. when the minute or hour ticks up).

Using it is very simple:

use DateTime::React;

react {
whenever minute-shifts {
say "We've gone from ??:??:59 to ??:??:00!";
}
whenever hour-shifts {
say "We've gone from ??:59:59 to to ??:00:00!";
}
whenever day-shifts {
say "We've gone from 23:59:59 to to 00:00:00!";
}
whenever timezone-shifts -> $shift {
say "The offset in {$shift.timezone} is now {$shift.new-offset}!";
}
}

Other time options presently include `month-shifts` and `year-shifts` (these are pegged to the Gregorian calendar).

Each supply emits a meta event of type `DateTimeEventish`. It provides three values:
* **`time`**: the time the event was scheduled
* **`next-at`**: when the next event will occur
* **`type`**: the type of event (any of *minute, hour, day, month, year, timezone*)

Currently, only `timezone-shifts()` provides additional metadata:
* **`olson-id`**: the Olson (or IANA) identifier for the timezone
* **`timezone`**: an alias of `olson-id`
* **`old-offset`**: the former GMT offset (e.g. -5h for *America/New_York* for spring switch over)
* **`new-offset`**: the now current GMT offset (e.g. -4h for *America/New_York* for spring switch over)

When using `timezone-shifts()`, this module will (currently) automatically adjust the `$*TZ` value for you so that new DateTime objects are generated with the correct offset.
Be mindful that DateTime itself is not timezone aware, so creating historical/future dates will always use the current $*TZ value.
If that is needed, you should look at the `DateTime::Timezones` module which does that for you.

The `$*TZ` adjusting feature may be moved into a different module down the road but the behavior will be maintained (at the cost of an additional dependency for this one).

# Version history
* **v0.2.0**
* Now using terms to avoid parentheses for teh pretty
* **v0.1.1**
* Switched to live supplies internally for improved reliability
* **v0.1.0**
* Initial release