TypeScript:
Arbeiten mit YAML

Wie geht das:

Die Arbeit mit YAML in TypeScript beinhaltet typischerweise das Parsen von YAML-Inhalten in JavaScript-Objekte und möglicherweise das Umwandeln von JavaScript-Objekten zurück in YAML. Dies erfordert einen Parser; eine beliebte Wahl ist js-yaml, eine Bibliothek, die leicht in TypeScript-Projekte integriert werden kann.

js-yaml installieren

Fügen Sie zunächst js-yaml zu Ihrem Projekt hinzu:

npm install js-yaml

YAML in JavaScript-Objekt parsen

Stellen Sie sich vor, Sie haben eine YAML-Datei config.yaml mit folgendem Inhalt:

database:
  host: localhost
  port: 5432
  username: user
  password: pass

Sie können diese Datei wie folgt in ein JavaScript-Objekt lesen und parsen:

import * as fs from 'fs';
import * as yaml from 'js-yaml';

// Laden und parsen Sie die YAML-Datei
const fileContents = fs.readFileSync('./config.yaml', 'utf8');
const data = yaml.load(fileContents) as Record<string, any>;

console.log(data);

Beispielausgabe:

{
  "database": {
    "host": "localhost",
    "port": 5432,
    "username": "user",
    "password": "pass"
  }
}

JavaScript-Objekt in YAML umwandeln

Wenn Sie den umgekehrten Weg gehen müssen und ein JavaScript-Objekt in einen YAML-String umwandeln müssen, können Sie js-yaml wie folgt verwenden:

import * as yaml from 'js-yaml';

const obj = {
  title: "Beispiel",
  is_published: true,
  author: {
    name: "Jane Doe",
    age: 34
  }
};

const yamlStr = yaml.dump(obj);
console.log(yamlStr);

Beispielausgabe:

title: Beispiel
is_published: true
author:
  name: Jane Doe
  age: 34

Dieser Schnipsel konvertiert ein JavaScript-Objekt in einen YAML-String und gibt ihn aus. In der Praxis könnten Sie dies zurück in eine Datei schreiben oder in anderen Teilen Ihrer Anwendung verwenden.