Home > @lynx-js/rspeedy > CreateRspeedyOptions

CreateRspeedyOptions interface

The options of createRspeedy method.

Signature:

export interface CreateRspeedyOptions 

Properties

PropertyModifiersTypeDescription
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.dev/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.