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/rspeedy/rspeedy.createrspeedyoptions.md.
Rspeedy logo
Rspeedy
  • 简体中文
  • Home > @lynx-js/rspeedy > CreateRspeedyOptions

    CreateRspeedyOptions interface

    The options of createRspeedy method.

    Signature:

    export interface CreateRspeedyOptions 

    Properties

    Property

    Modifiers

    Type

    Description

    callerName?

    string

    (Optional) The name of the framework or tool that is currently invoking Rsbuild. This allows plugins to tailor their behavior based on the calling context.

    cwd?

    string

    (Optional) The root path of the current build.

    environment?

    CreateRsbuildOptions['environment']

    (Optional) Only build specified environments. For example, passing ['lynx'] will only build the lynx environment. If not specified or passing an empty array, all environments will be built.

    loadEnv?

    CreateRsbuildOptions['loadEnv']

    (Optional) Rspeedy automatically loads the .env file by default, utilizing the [Rsbuild API](https://rsbuild.rs/api/javascript-api/core\#load-env-variables). You can use the environment variables defined in the .env file within your code by accessing them via import.meta.env.FOO or process.env.Foo.

    rspeedyConfig?

    Config

    (Optional) The config of Rspeedy.

    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。