Interface ConfigPluginOpts

Less than 1 minute

Interface ConfigPluginOpts

Declared in packages/sdk/config/src/plugin/types.ts

Properties

configPathopen in new window

Type: string

Path to the DX config files, defaults to current working directory.

devPathopen in new window

Type: string

Path to the development overrides for DX config.

dynamicopen in new window

Type: boolean

The Dynamics() config.yml file is special, it will be loaded if the dynamic property is set to false. If dynamic is set to true each app will try to load from an endpoint (using {publicUrl}/.well-known/dx/config), wire app serve adds config endpoints for each app serving the global config file (~/.wire/remote.yml).

The usual pattern is to set it to CONFIG_DYNAMIC env variable. When running app locally this should be set to false or nil to serve local config. And when publishing the app to DXNS the cli-app will set that variable to true automatically.

envopen in new window

Type: string[]

Environment variables to be passed to the app.

envPathopen in new window

Type: string

Path to the environment variable overrides for DX config.

publicUrlopen in new window

Type: string

Public URL of the published app. Also used to load the dynamic config.