ספרים
TypeScript
פרק 10. פורמטים של נתונים וסריאליזציה
עבודה עם YAML

TypeScript:
עבודה עם YAML

איך לעשות זאת:

עבודה עם YAML ב-TypeScript בדרך כלל כוללת פרסור של תוכן YAML לאובייקטים של JavaScript ואפשר גם המרה של אובייקטים של JavaScript בחזרה ל-YAML. זה דורש מפענח; אחת הבחירות הפופולריות היא js-yaml, ספריה שניתן לשלב בקלות בפרויקטים של TypeScript.

התקנת js-yaml

ראשית, הוספו את js-yaml לפרויקט שלכם:

npm install js-yaml

פרסור YAML לאובייקט JavaScript

נניח שיש לכם קובץ YAML config.yaml עם התוכן הבא:

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

תוכלו לקרוא ולפרסר קובץ זה לאובייקט של JavaScript כדלהלן:

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

// טעינה ופרסור של קובץ ה-YAML
const fileContents = fs.readFileSync('./config.yaml', 'utf8');
const data = yaml.load(fileContents) as Record<string, any>;

console.log(data);

דוגמת פלט:

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

המרת אובייקט JavaScript ל-YAML

אם אתם צריכים לעשות את הכיוון השני ולהמיר אובייקט של JavaScript למחרוזת YAML, ניתן להשתמש ב-js-yaml כך:

import * as yaml from 'js-yaml';

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

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

דוגמת פלט:

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

קטע קוד זה ממיר אובייקט JavaScript למחרוזת YAML ומציג אותה. בפועל, ייתכן שתכתבו זאת בחזרה לקובץ או תשתמשו בה בחלקים אחרים של היישום שלכם.

עבודה עם XML