blob: ba56893dfac912c0c26bf4c3fd066d5bda34c650 [file] [log] [blame] [view]
[![Build Status](https://github.com/dart-lang/tools/actions/workflows/yaml.yaml/badge.svg)](https://github.com/dart-lang/tools/actions/workflows/yaml.yaml)
[![pub package](https://img.shields.io/pub/v/yaml.svg)](https://pub.dev/packages/yaml)
[![package publisher](https://img.shields.io/pub/publisher/yaml.svg)](https://pub.dev/packages/yaml/publisher)
A parser for [YAML](https://yaml.org/).
## Usage
Use `loadYaml` to load a single document, or `loadYamlStream` to load a
stream of documents. For example:
```dart
import 'package:yaml/yaml.dart';
main() {
var doc = loadYaml("YAML: YAML Ain't Markup Language");
print(doc['YAML']);
}
```
This library currently doesn't support dumping to YAML. You should use
`json.encode` from `dart:convert` instead:
```dart
import 'dart:convert';
import 'package:yaml/yaml.dart';
main() {
var doc = loadYaml("YAML: YAML Ain't Markup Language");
print(json.encode(doc));
}
```