df_type 0.4.1

A package designed to simplify and enhance interactions with Dart types.

DF - Type

Dart & Flutter Packages by DevCetra.com & contributors.

Summary

A package designed to simplify and enhance interactions with Dart types. For a full feature set, please refer to the API reference.

Usage Example

enum Alphabet { A, B, C }

// Convert a String to an enum.
print(Alphabet.values.valueOf('A') == Alphabet.A); // true
print(Alphabet.values.valueOf('a') == Alphabet.A); // true
print(Alphabet.values.valueOf('b')); // Alphabet.B
print(Alphabet.values.valueOf('qwerty') == null); // true

// Check if a type is nullable or not.
print(isNullable<String>()); // false
print(isNullable<String?>()); // true
print(isNullable<Null>()); // true

// Check if a type can be compared by value.
print(isEquatable<double>()); // true
print(isEquatable<Null>()); // true
print(isEquatable<Map<dynamic, dynamic>>()); // false
print(isEquatable<Equatable>()); // true

// Only let a value be of a certain type, or return null.
print(letAsOrNull<String>(DateTime.now())); // null
print(letAsOrNull<DateTime>(DateTime.now())); // returns the value
print(letAsOrNull<DateTime?>(DateTime.now())); // returns the value
print(letAsOrNull<DateTime?>(null)); // null

// Lazy-convert any standard dart type (num, double, bool, String, Duration,
// DateTime, etc.) to an int if sensible or return null:
final int? i = letIntOrNull('55');
print(i); // 55

// Lazy-convert any map from one type to another if sensible, otherwise
// return null.
final Map<String, int>? m = letMapOrNull<String, int>({55: '56'});
print(m); // {55, 56}

// Lazy-convert comma separated strings, a value, or an iterable to a list if
// sensible, otherwise return null.
print(letListOrNull<int>('1, 2, 3, 4')); // [1, 2, 3, 4]
print(letListOrNull<int>('[1, 2, 3, 4]')); // [1, 2, 3, 4]
print(letListOrNull<int>([1, 2, 3, 4])); // [1, 2, 3, 4]
print(letListOrNull<int>(1)); // [1]

// Lazy-convert any value to a double if sensible, otherwise return null.
print(letOrNull<double>('123')); // 123.0

// Convert a String to a Duration.
final Duration duration = const ConvertStringToDuration('11:11:00.00').toDuration();
print(duration); // 11:11:00.000000

// Manage Futures or values via FutureOrController.
final a1 = Future.value(1);
final a2 = 2;
final a3 = Future.value(3);
final foc1 = FutureOrController<dynamic>([() => a1, () => a2, () => a3]);
final f1 = foc1.completeWithAll();
print(f1 is Future); // true
print(await f1); // [1, 2, 3]
final b1 = 1;
final b2 = 2;
final b3 = 2;
final foc2 = FutureOrController<dynamic>([() => b1, () => b2, () => b3]);
final f2 = foc2.completeWithAll();
print(f2 is Future); // false
print(f2); // [1, 2, 3]

// CompleterOr works with async or sync values.
final completerOr1 = CompleterOr<int>();
completerOr1.complete(1);
final c1 = completerOr1.futureOr;
print(c1 is Future); // false
final completerOr2 = CompleterOr<int>();
completerOr2.complete(Future.value(1));
final c2 = completerOr2.futureOr;
print(c2 is Future); // true

// The FunctionQueue can ensure that async functions will execute in the same
// order as they are added. This can be used for database writes, for example.
final functionQueue = FunctionQueue();
functionQueue.add(() async {
print('Function 1 running');
await Future<void>.delayed(const Duration(seconds: 3));
print('Function 1 completed');
});
functionQueue.add(() async {
print('Function 2 running');
await Future<void>.delayed(const Duration(seconds: 2));
print('Function 2 completed');
});
functionQueue.add(() async {
print('Function 3 running');
await Future<void>.delayed(const Duration(seconds: 1));
print('Function 3 completed');
});
await functionQueue.wait();
// Prints:
// Function 1 running
// Function 1 completed
// Function 2 running
// Function 2 completed
// Function 3 running
// Function 3 completed
print(functionQueue.add(() => 'Hello!').runtimeType); // String
print(functionQueue.add(() => 'World!')); // World!

Installation

Use this package as a dependency by adding it to your pubspec.yaml file (see here).

---

Contributing and Discussions

This is an open-source project, and we warmly welcome contributions from everyone, regardless of experience level. Whether you're a seasoned developer or just starting out, contributing to this project is a fantastic way to learn, share your knowledge, and make a meaningful impact on the community.

Ways you can contribute:

• Buy me a coffee: If you'd like to support the project financially, consider buying me a coffee. Your support helps cover the costs of development and keeps the project growing.
• Share your ideas: Every perspective matters, and your ideas can spark innovation.
• Report bugs: Help us identify and fix issues to make the project more robust.
• Suggest improvements or new features: Your ideas can help shape the future of the project.
• Help clarify documentation: Good documentation is key to accessibility. You can make it easier for others to get started by improving or expanding our documentation.
• Write articles: Share your knowledge by writing tutorials, guides, or blog posts about your experiences with the project. It's a great way to contribute and help others learn.

No matter how you choose to contribute, your involvement is greatly appreciated and valued!

---

Chief Maintainer:

📧 Email Robert Mollentze at [e-mail]

Dontations:

If you're enjoying this package and find it valuable, consider showing your appreciation with a small donation. Every bit helps in supporting future development. You can donate here:

https://www.buymeacoffee.com/robmllze

---

License

This project is released under the MIT License. See LICENSE for more information.