For AI agents: the complete documentation index is available at /next/zh/llms.txt, the full documentation bundle is available at /next/zh/llms-full.txt, and this page is available as Markdown at /next/zh/api/packages/rspeedy/functions/defineConfig.md.
Lynx
  • 简体中文
  • 函数: defineConfig()

    调用签名

    defineConfig(config: Config): Config

    defineConfig 方法是一个辅助函数,用于获取 TypeScript 智能提示。

    参数

    参数类型描述
    configConfigRspeedy 的配置。

    返回

    Config

    与输入配置完全相同的配置。

    示例

    在 lynx.config.ts 中使用 defineConfig:

    import { defineConfig } from '@lynx-js/rspeedy'
    export default defineConfig({
      // autocompletion works here!
    })

    调用签名

    defineConfig(config: (params: ConfigParams) => Config): (params: ConfigParams) => Config

    defineConfig 方法是一个辅助函数,用于获取 TypeScript 智能提示。

    参数

    参数类型描述
    config(params: ConfigParams) => Config返回 Rspeedy 配置的函数。

    返回

    与输入完全相同的函数。

    (params: ConfigParams) => Config

    示例

    在 lynx.config.ts 中使用 defineConfig:

    import { defineConfig } from '@lynx-js/rspeedy'
    export default defineConfig(() => {
      return {
        // autocompletion works here!
      }
    })

    在 lynx.config.ts 中带参数使用 defineConfig:

    import { defineConfig } from '@lynx-js/rspeedy'
    
    export default defineConfig(({ env }) => {
      const isTest = env === 'test'
      return {
        output: {
          minify: isTest ? false : true,
        },
      }
    })

    调用签名

    defineConfig(config: Promise<Config>): Promise<Config>

    defineConfig 方法是一个辅助函数,用于获取 TypeScript 智能提示。

    参数

    参数类型描述
    configPromise<Config>解析为 Rspeedy 配置的 Promise。

    返回

    Promise<Config>

    与输入完全相同的 Promise。

    示例

    在 lynx.config.ts 中使用 defineConfig:

    import { defineConfig } from '@lynx-js/rspeedy'
    
    export default defineConfig(
      import('@lynx-js/react-rsbuild-plugin').then(({ pluginReactLynx }) => ({
        plugins: [pluginReactLynx()],
      })),
    );

    调用签名

    defineConfig(config: (params: ConfigParams) => Promise<Config>): (params: ConfigParams) => Promise<Config>

    defineConfig 方法是一个辅助函数,用于获取 TypeScript 智能提示。

    参数

    参数类型描述
    config(params: ConfigParams) => Promise<Config>返回一个解析为 Rspeedy 配置的 Promise 的函数。

    返回

    与输入完全相同的函数。

    (params: ConfigParams) => Promise<Config>

    示例

    在 lynx.config.ts 中使用 defineConfig:

    import { defineConfig } from '@lynx-js/rspeedy'
    export default defineConfig(async () => {
      const foo = await bar()
      return {
        // autocompletion works here!
      }
    })

    在 lynx.config.ts 中带参数使用 defineConfig:

    import { defineConfig } from '@lynx-js/rspeedy'
    
    export default defineConfig(async ({ env }) => {
      const foo = await bar()
      const isTest = env === 'test'
      return {
        output: {
          minify: isTest ? false : true,
        },
      }
    })
    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。