Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zuraguerra/dumballah
Tiny library that makes easier the manipulation of Unix timestamps, named after a voodoo Loa
https://github.com/zuraguerra/dumballah
Last synced: about 1 month ago
JSON representation
Tiny library that makes easier the manipulation of Unix timestamps, named after a voodoo Loa
- Host: GitHub
- URL: https://github.com/zuraguerra/dumballah
- Owner: ZuraGuerra
- Created: 2016-09-07T05:13:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-05T22:57:35.000Z (about 8 years ago)
- Last Synced: 2024-10-02T16:08:13.221Z (about 1 month ago)
- Language: Elixir
- Homepage: https://hex.pm/packages/dumballah
- Size: 23.4 KB
- Stars: 21
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dumballah
[](https://travis-ci.org/ZuraGuerra/dumballah)
[](http://inch-ci.org/github/ZuraGuerra/dumballah)
[](https://beta.hexfaktor.org/github/ZuraGuerra/dumballah)
[](https://hex.pm/packages/dumballah)
---
Dumballah is a tiny library that provides conversions between seconds and other time units, and some useful calculations to make easier the manipulation of Unix timestamps.
Dumballah is a voodoo Loa associated with the rain and the crops, that's why I chose his name for a library about time.
Here is the [documentation](https://hexdocs.pm/dumballah/api-reference.html).
## Requirements
Elixir 1.3+.
## Installation
Just add it to your `mix.exs` file:
```elixir
defp deps do
[{:dumballah, "~> 2.3"}]
end
```
## Usage
### Conversions
From `:hours`, `:days` and `:minutes` to seconds.
```elixir
Dumballah.Convert.to_seconds(:hours, 7)
> 25200
```
And viceversa.
```elixir
Dumballah.Convert.from_seconds(:hours, 25200)
> 7.0
```
### Calculations
Add and subtract `:hours`, `:days` and `:minutes` in seconds.
```elixir
Dumballah.now
|> Dumballah.Calculate.add_time(:days, 1)
> 1473962718
```
Identify passed timestamps.
```elixir
Dumballah.now
|> Dumballah.Calculate.has_passed?
> true
```
And more, like `date_from_dawn/1` and `seconds_until_midnight/1`: check the [docs](https://hexdocs.pm/dumballah/api-reference.html).
## Notes
`Dumballah.now/0` returns your current local time in seconds. If you need the current UTC time, use `DateTime.utc_now/0`, which is part of the Elixir standard library since 1.3.
## Recommended Readings
Working with date times is a [real](http://infiniteundo.com/post/25326999628/falsehoods-programmers-believe-about-time) [pain](http://infiniteundo.com/post/25509354022/more-falsehoods-programmers-believe-about-time); these links provide some insights on how the Erlang VM deals with time. You might find them useful.
[`calendar` module docs](http://erlang.org/doc/man/calendar.html)
[`os:timestamp/0` docs](http://erlang.org/doc/man/os.html#timestamp-0)
[`time/0` docs](http://erlang.org/doc/man/erlang.html#time-0)
[Time Correction in Erlang](http://erlang.org/doc/apps/erts/time_correction.html)
---
Sponsored by [steed.](http://steed.mx/)
