@salesforce/b2c-tooling-sdk / operations/mrt / SetEnvVarBackendOptions
Interface: SetEnvVarBackendOptions
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:630
Options for setEnvVarWithBackend.
Extends
Properties
environment
environment:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:523
Target/environment slug (= SCAPI environment ID).
Inherited from
EnvVarBackendOptions.environment
key
key:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:632
Environment variable name.
legacyAuth?
optionallegacyAuth:AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:519
Legacy API-key auth strategy. Optional; required only when the legacy backend actually runs.
Inherited from
EnvVarBackendOptions.legacyAuth
onFallback()?
optionalonFallback: (reason) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:527
Invoked when auto falls back from SCAPI to legacy.
Parameters
reason
string
Returns
void
Inherited from
EnvVarBackendOptions.onFallback
onResolve()?
optionalonResolve: (backend) =>void
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:529
Invoked with the backend that serves the call (for -D debug).
Parameters
backend
Returns
void
Inherited from
EnvVarBackendOptions.onResolve
origin?
optionalorigin:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:525
Legacy MRT API origin.
Inherited from
preference
preference:
MrtBackendPreference
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:515
Resolved --mrt-backend preference.
Inherited from
EnvVarBackendOptions.preference
projectSlug
projectSlug:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:521
Project slug (= SCAPI storefront ID).
Inherited from
EnvVarBackendOptions.projectSlug
scapiConnection?
optionalscapiConnection:ScapiMrtConnection
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:517
SCAPI connection; when absent, auto uses legacy and scapi throws.
Inherited from
EnvVarBackendOptions.scapiConnection
value
value:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/env-var.ts:634
Environment variable value.