TypeScript:
使用YAML工作

如何操作:

在TypeScript中处理YAML通常涉及将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字符串并输出它。实际上,您可能会将此写回到文件,或在应用程序的其他部分使用它。