Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 1.67 KB

README.md

File metadata and controls

71 lines (48 loc) · 1.67 KB

data_class

build pub package License: MIT

Support for data classes in Dart using macros.

✨ Features

🪨 const constructors with required, named parameters

🖨️ copyWith with optional, nullable, named parameters

toString for an improved string representation

☯️ operator== and hashCode for value equality

🧑‍💻 Example

import 'package:data_class/data_class.dart';

@Data()
class Person {
  final String name;
}

void main() {
  // 🪨 Create a const instance with required, name parameters.
  const dash = Person(name: 'Dash');

  // 🖨️ Create copies of your object.
  final sparky = dash.copyWith(name: 'Sparky');

  // ✨ Human-readable string representation.
  print(dash); // Person(name: Dash)
  print(sparky); // Person(name: Sparky)

  // ☯️ Value equality comparisons.
  print(dash == dash.copyWith()); // true
  print(dash == sparky); // false
}

🚀 Quick Start

  1. Add package:data_class to your pubspec.yaml

    dependencies:
      data_class: any
  2. Enable experimental macros in analysis_options.yaml

    analyzer:
      enable-experiment:
        - macros
  3. Use the @Data annotation (see above example).

  4. Run it

    dart --enable-experiment=macros run main.dart

*Requires Dart SDK >= 3.5.0