TypeScript:
Att Arbeta med YAML
Hur man gör:
Att arbeta med YAML i TypeScript innebär vanligtvis att tolka YAML-innehåll till JavaScript-objekt och möjligen konvertera JavaScript-objekt tillbaka till YAML. Detta kräver en tolk; ett populärt val är js-yaml
, ett bibliotek som enkelt kan integreras i TypeScript-projekt.
Installera js-yaml
Först, lägg till js-yaml
i ditt projekt:
npm install js-yaml
Tolka YAML till JavaScript-objekt
Föreställ dig att du har en YAML-fil config.yaml
med följande innehåll:
database:
host: localhost
port: 5432
username: user
password: pass
Du kan läsa och tolka denna fil till ett JavaScript-objekt på följande sätt:
import * as fs from 'fs';
import * as yaml from 'js-yaml';
// Ladda och tolka YAML-filen
const fileContents = fs.readFileSync('./config.yaml', 'utf8');
const data = yaml.load(fileContents) as Record<string, any>;
console.log(data);
Exempelutskrift:
{
"database": {
"host": "localhost",
"port": 5432,
"username": "user",
"password": "pass"
}
}
Konvertera JavaScript-objekt till YAML
Om du behöver gå åt andra hållet och konvertera ett JavaScript-objekt till en YAML-sträng kan du använda js-yaml
på följande sätt:
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);
Exempelutskrift:
title: Example
is_published: true
author:
name: Jane Doe
age: 34
Detta kodsnutt konverterar ett JavaScript-objekt till en YAML-sträng och skriver ut den. I praktiken kan du skriva tillbaka detta till en fil eller använda det i andra delar av din applikation.