temporal_json_converter #

json_serializable converters for every type in the temporal package.

Getting started #

dependencies:
  temporal: ^0.1.1
  temporal_json_converter: ^0.1.0
  json_annotation: ^4.9.0

dev_dependencies:
  build_runner: ^2.0.0
  json_serializable: ^6.0.0

Usage #

Annotate fields with the static converter that matches the type:

import 'package:json_annotation/json_annotation.dart';
import 'package:temporal/temporal.dart';
import 'package:temporal_json_converter/temporal_json_converter.dart';

part 'event.g.dart';

@JsonSerializable()
class Event {
  @TemporalJsonConverter.plainDate
  final PlainDate date;

  @TemporalJsonConverter.plainTime
  final PlainTime time;

  @TemporalJsonConverter.zonedDateTime
  final ZonedDateTime start;

  @TemporalJsonConverter.instant
  final Instant createdAt;

  @TemporalJsonConverter.duration
  final TemporalDuration length;

  const Event({
    required this.date,
    required this.time,
    required this.start,
    required this.createdAt,
    required this.length,
  });

  factory Event.fromJson(Map<String, dynamic> json) => _$EventFromJson(json);
  Map<String, dynamic> toJson() => _$EventToJson(this);
}

All converters serialize to and from ISO 8601 strings — the canonical wire format for each type:

The converters can also be used directly without json_serializable:

const converter = TemporalJsonConverter.plainDate;

final date = converter.fromJson('2024-03-15');   // PlainDate
final json = converter.toJson(date);             // '2024-03-15'

Additional information #

• temporal — the Temporal types package
• TC39 Temporal proposal
• File issues at the GitHub issue tracker