Bun 原生支持 .yaml
和 .yml
导入。
database:
host: localhost
port: 5432
name: myapp
server:
port: 3000
timeout: 30
features:
auth: true
rateLimit: true
像导入其他源文件一样导入文件。
import config from "./config.yaml";
config.database.host; // => "localhost"
config.server.port; // => 3000
config.features.auth; // => true
您还可以使用具名导入来解构顶层属性
import { database, server, features } from "./config.yaml";
console.log(database.name); // => "myapp"
console.log(server.timeout); // => 30
console.log(features.rateLimit); // => true
Bun 还支持 导入属性 语法
import config from "./config.yaml" with { type: "yaml" };
config.database.port; // => 5432
要在运行时解析 YAML 字符串,请使用 Bun.YAML.parse()
const yamlString = `
name: John Doe
age: 30
hobbies:
- reading
- coding
`;
const data = Bun.YAML.parse(yamlString);
console.log(data.name); // => "John Doe"
console.log(data.hobbies); // => ["reading", "coding"]
TypeScript 支持
要为您的 YAML 导入添加 TypeScript 支持,请创建一个以 .d.ts
结尾的声明文件(例如,config.yaml
→ config.yaml.d.ts
);
const contents: {
database: {
host: string;
port: number;
name: string;
};
server: {
port: number;
timeout: number;
};
features: {
auth: boolean;
rateLimit: boolean;
};
};
export = contents;
有关 Bun 中 YAML 支持的完整文档,请参阅 文档 > API > YAML。