For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/rspeedy/rspeedy.defineconfig_2.md.
Rspeedy logo
Rspeedy
  • English
  • Home > @lynx-js/rspeedy > defineConfig

    defineConfig() function

    The defineConfig method is a helper function used to get TypeScript intellisense.

    Signature:

    export declare function defineConfig(config: Promise<Config>): Promise<Config>;

    Parameters

    Parameter

    Type

    Description

    config

    Promise<Config>

    The promise that resolves to a config of Rspeedy.

    Returns:

    Promise<Config>

    • The identical promise as the input.

    Example

    Use defineConfig in lynx.config.ts:

    import { defineConfig } from '@lynx-js/rspeedy'
    
    export default defineConfig(
      import('@lynx-js/react-rsbuild-plugin').then(({ pluginReactLynx }) => ({
        plugins: [pluginReactLynx()],
      })),
    );
    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.