Skip to content

O Bun suporta nativamente imports de .yaml e .yml.

yaml
database:
  host: localhost
  port: 5432
  name: myapp

server:
  port: 3000
  timeout: 30

features:
  auth: true
  rateLimit: true

Importe o arquivo como qualquer outro arquivo de código.

ts
import config from "./config.yaml";

config.database.host; // => "localhost"
config.server.port; // => 3000
config.features.auth; // => true

Você também pode usar imports nomeados para desestruturar propriedades de nível superior:

ts
import { database, server, features } from "./config.yaml";

console.log(database.name); // => "myapp"
console.log(server.timeout); // => 30
console.log(features.rateLimit); // => true

O Bun também suporta a sintaxe Import Attributes:

ts
import config from "./config.yaml" with { type: "yaml" };

config.database.port; // => 5432

Para analisar strings YAML em tempo de execução, use Bun.YAML.parse():

ts
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"]

Suporte TypeScript

Para adicionar suporte TypeScript para seus imports YAML, crie um arquivo de declaração com .d.ts adicionado ao nome do arquivo YAML (por exemplo, config.yamlconfig.yaml.d.ts);

ts
const contents: {
  database: {
    host: string;
    port: number;
    name: string;
  };
  server: {
    port: number;
    timeout: number;
  };
  features: {
    auth: boolean;
    rateLimit: boolean;
  };
};

export = contents;

Consulte Docs > API > YAML para documentação completa sobre suporte YAML no Bun.

Bun by www.bunjs.com.cn edit