jalali_date_time 1.0.0

A simple JalaliDateTime implementation over dart's DateTime

JalaliDateTime

JalaliDateTime is a Dart package that provides a convenient way to work with Jalali (Persian) dates while using the underlying DateTime structure for time-related methods. This approach is designed to maintain stability and efficiency in your code.

Features

• Jalali Date Representation: The package allows you to easily represent Jalali dates, including year, month, and day.

• DateTime Compatibility: For time-related methods such as comparison, subtraction, and more, JalaliDateTime utilizes the DateTime methods, ensuring reliability and accuracy.

• Efficient Design: Each Jalali instance seamlessly holds its corresponding DateTime, minimizing overhead and computational load.

Installation

To use JalaliDateTime in your Dart project, add it as a dependency in your pubspec.yaml file:

dependencies:
  jalali_date_time: ^1.0.0

Then, run flutter pub get to fetch the package.

Usage

Here's a basic example of how to use JalaliDateTime:

import 'package:jalali_date_time/jalali_date_time.dart';

void main() {
  // Create a JalaliDateTime instance for the current date and time
  final jalaliNow = JalaliDateTime.now();

  // Access Jalali components
  final year = jalaliNow.year;
  final month = jalaliNow.month;
  final day = jalaliNow.day;
  print('today: $year-$month-$day');
  // Convert JalaliDateTime to DateTime
  final dateTime = jalaliNow.toDateTime();

  // Perform DateTime operations
  final tomorrow = dateTime.add(const Duration(days: 1));
  final tyear = tomorrow.year;
  final tmonth = tomorrow.month;
  final tday = tomorrow.day;
  print('tomorrow: $tyear-$tmonth-$tday');
  // Convert DateTime back to JalaliDateTime
  final jalaliTomorrow = JalaliDateTime.fromDateTime(tomorrow);

  // Compare JalaliDateTime objects
  if (jalaliTomorrow.isAfter(jalaliNow)) {
    // ignore: prefer_single_quotes
    print("Tomorrow is after today.");
  }
}

Contribution

Contributions are welcome! If you encounter any issues, have feature requests, or want to contribute code, please feel free to open an issue or create a pull request.

License

This package is distributed under the MIT License. See the LICENSE file for more information.

---

Note: This package is primarily focused on providing a stable and efficient way to work with Jalali dates. For more detailed documentation and usage examples, refer to the package documentation or visit the GitHub repository.

For additional information on the Jalali calendar, consider referencing external resources and documentation on the Persian calendar system.