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.createrspeedyoptions.md.
Rspeedy logo
Rspeedy
  • English

      • 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.

      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.