Skip to content

运行时配置

此 API 仍处于开发阶段,未来将添加更多功能!

<srcDir>/app.config.ts 中定义运行时配置:

typescript
import { defineAppConfig } from 'wxt/sandbox';

// 定义您所需的类型
declare module 'wxt/sandbox' {
  export interface WxtAppConfig {
    theme?: 'light' | 'dark';
  }
}

export default defineAppConfig({
  theme: 'dark',
});

WARNING

此文件已提交至仓库,因此不要在此存储任何机密信息。相反,请使用 环境变量

要访问运行时配置,WXT 提供了 useAppConfig 函数:

typescript
import { useAppConfig } from 'wxt/sandbox';

console.log(useAppConfig()); // { theme: "dark" }

应用配置中的环境变量

您可以在 app.config.ts 文件中使用环境变量。

typescript
declare module 'wxt/sandbox' {
  export interface WxtAppConfig {
    apiKey?: string;
    skipWelcome: boolean;
  }
}

export default defineAppConfig({
  apiKey: import.meta.env.WXT_API_KEY,
  skipWelcome: import.meta.env.WXT_SKIP_WELCOME === 'true',
});

此方法具有以下优点:

  • 将所有预期的环境变量集中在一个文件中
  • 将字符串转换为其他类型,例如布尔值或数组
  • 提供默认值,如果未提供某个环境变量