Pakete, Repositories und App-Kategorien suchen

Paketdetailsv2.1.0

yaml_writer

Eine Bibliothek zum Schreiben von YAML-Dokumenten, die Objektcodierung und 'Converter' aus 'dart:convert' unterstützt.

AndroidiOSWebmacOSWindowsLinux
30-Tage-Downloads
666.000
Likes
29
Pub-Punkte
160

Paket installieren

flutter pub add yaml_writer

Paketübersicht

Aus öffentlichen Paketdaten erstellte Orientierung.

yaml_writer ist eine Dart-Bibliothek, die entwickelt wurde, um YAML-Dokumente mit Unterstützung für Objektencodierung und Integration mit der Converter-Schnittstelle von 'dart:convert' zu generieren. Sie ermöglicht die nahtlose Serialisierung von Dart-Objekten in strukturiertes YAML-Format und eignet sich daher ideal für Konfigurationsdateien, Datenaustausch und dauerhafte Speicherung. Das Paket ist auf allen wichtigen Plattformen wie Android, iOS, Web, macOS, Windows und Linux kompatibel. Mit Fokus auf Einfachheit und Interoperabilität erweitert es das Standard-Dart-Ökosystem und gewährleistet saubere, lesbare Ausgaben.

Anwendungsfälle

  • Konfigurationsdateien generieren
  • Serialisieren von Dart-Objekten in YAML
  • Datenpersistenz im YAML-Format
  • Interoperabilität mit dart:convert
  • Erstellen von strukturierten Datenexports

Hauptmerkmale

  • Objektcodierungssupport
  • Integration mit dem Converter von dart:convert
  • Plattformübergreifende Kompatibilität
  • Klare und lesbare YAML-Ausgabe
  • Einfache API zum Schreiben von YAML-Dokumenten

Geeignet für

  • Entwickler, die mit Konfigurationsdaten arbeiten
  • Anwendungen, die YAML-Ausgabe erfordern
  • Projekte, die dart:convert-Utilities verwenden
  • Plattformübergreifende Flutter-Anwendungen
  • Werkzeuge, die strukturierte Textserialisierung benötigen

Hinweise

  • Beschränkt auf das Schreiben von YAML (kein Parsen)
  • Benötigt externe Abhängigkeiten für vollständige Funktionalität
  • Nicht für die großflächige YAML-Erzeugung optimiert
  • Keine eingebaute Überprüfung von Eingabeobjekten
  • Erfordert manuelle Behandlung komplexer verschachtelter Strukturen

Original-README

Originaler README-Schnappschuss aus dem verknüpften Quell-Repository. Aktuelle Inhalte finden Sie im Repository.

yaml_writer

pub package Null Safety Codecov Dart CI GitHub Tag New Commits Last Commits Pull Requests Code size License

A library to write YAML documents, supporting Object encoding and dart:convert Converter.

Usage

A simple usage example:

import 'package:yaml_writer/yaml_writer.dart';

void main() {
  final yamlWriter = YamlWriter();

  final yamlDoc = yamlWriter.write({
    'name': 'Joe',
    'ids': [10, 20, 30],
    'desc': 'This is\na multiline\ntext',
    'enabled': true,
  });

  print(yamlDoc);
}

OUTPUT:

name: "Joe"
ids: 
  - 10
  - 20
  - 30
desc: |-
    This is
    a multiline
    text
enabled: true

YAML Strings

The writer will try to encode strings using the best format depending on the text, avoiding to escape " and using | for multiline texts.

Encoding Objects

You can use YAMLWriter.toEncodable to convert an Object to an encodable version, similar to what is done by dart:convert JsonEncoder.

If YAMLWriter.toEncodable is not set, it will try to call toJson().

Features and bugs

Please file feature requests and bugs at the issue tracker.

Author

Graciliano M. Passos: gmpassos@GitHub.

Liplum: liplum@GitHub

License

Dart free & open-source license.

Kategorien

Quell-Repository

Projekte, die dieses Paket verwenden