Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jogboms/time.dart
⏰ Type-safe DateTime and Duration calculations, powered by extensions.
https://github.com/jogboms/time.dart
dart dartlang dartx datetime duration extensions flutter library time tools
Last synced: 23 days ago
JSON representation
⏰ Type-safe DateTime and Duration calculations, powered by extensions.
- Host: GitHub
- URL: https://github.com/jogboms/time.dart
- Owner: jogboms
- License: mit
- Created: 2019-10-10T08:05:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-09T06:21:05.000Z (5 months ago)
- Last Synced: 2024-10-04T03:53:14.063Z (about 1 month ago)
- Topics: dart, dartlang, dartx, datetime, duration, extensions, flutter, library, time, tools
- Language: Dart
- Homepage:
- Size: 90.8 KB
- Stars: 496
- Watchers: 10
- Forks: 29
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- my-awesome-list - time.dart - safe DateTime and Duration calculations, powered by extensions. | jogboms | 497 | (Dart)
README
# ⏰ Time
[](https://github.com/jogboms/time.dart/actions/workflows/build.yml) [](https://codecov.io/gh/jogboms/time.dart) [](https://pub.dartlang.org/packages/time)
With shiny extensions, if you have ever written something like this, then look no further:
```dart
final DateTime fourHoursFromNow = DateTime.now() + Duration(hours: 4);
```
## 🎖 Installation
```yaml
dependencies:
time: "^2.1.4"
```
### ⚡ Import
```dart
import 'package:time/time.dart';
```
## 🎮 Usage
```dart
final Duration tenMinutes = 10.minutes;
final Duration oneHourThirtyMinutes = 1.5.hours;
final DateTime afterTenMinutes = DateTime.now() + 10.minutes;
final Duration tenMinutesAndSome = 10.minutes + 15.seconds;
final int tenMinutesInSeconds = 10.minutes.inSeconds;
final DateTime tenMinutesFromNow = 10.minutes.fromNow;
```
You can perform all basic arithmetic operations on `Duration` as you always have been:
```dart
final Duration interval = 10.minutes + 15.seconds - 3.minutes + 2.hours;
final Duration doubled = interval * 2;
```
You can also use these operations on `DateTime`:
```dart
final DateTime oneHourAfter = DateTime() + 1.hours;
```
`Duration` is easily convertible as it always has been:
```dart
final int twoMinutesInSeconds = 2.minutes.inSeconds;
```
You can also convert `Duration` to `DateTime`, if needed:
```dart
final DateTime timeInFuture = 5.minutes.fromNow;
final DateTime timeInPast = 5.minutes.ago;
```
Iterate through a `DateTime` range:
```dart
final DateTime start = DateTime(2019, 12, 2);
final DateTime end = start + 1.weeks;
final DateTime tuesday = start.to(end).firstWhere((date) => date.weekday == DateTime.tuesday);
```
Granular comparison between `DateTime` fields:
```dart
final DateTime specificDate = DateTime(2021, 01, 01);
final DateTime otherDate = DateTime(2021, 02, 01);
print(specificDate.isAtSameYearAs(otherDate)); // true
print(specificDate.isAtSameMonthAs(otherDate)); // false
print(specificDate.isAtSameDayAs(otherDate)); // false
```
You can also delay code execution:
```dart
void doSomething() async {
await 5.seconds.delay;
// Do the other things
}
```
You can also use the popular `copyWith`:
```dart
final initial = DateTime(2019, 2, 4, 24, 50, 45, 1, 1);
final expected = initial.copyWith(
year: 2021,
month: 10,
day: 28,
hour: 12,
minute: 45,
second: 10,
millisecond: 0,
microsecond: 12,
);
```
Visit the [API Reference](https://pub.dev/documentation/time/latest/time/time-library.html) to find out all that is available.
## 🐛 Bugs/Requests
If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on Github and I'll look into it. Pull request are also welcome.
## 👏 Inspiration
- Swift library of the same name - [Time](https://github.com/dreymonde/Time).
- Kotlin library of the same name - [Time](https://github.com/kizitonwose/Time).
## ⭐ License
MIT License