Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / scaffold / resolveScaffoldParameters

Function: resolveScaffoldParameters()

resolveScaffoldParameters(scaffold, options): Promise<ResolvedParameters>

Defined in: packages/b2c-tooling-sdk/src/scaffold/parameter-resolver.ts:78

Resolve scaffold parameters by:

  1. Validating provided variables against sources
  2. Setting companion path variables for cartridges
  3. Applying defaults where appropriate
  4. Filtering by condition (when field)
  5. Collecting missing required parameters

Parameters

scaffold

Scaffold

The scaffold to resolve parameters for

options

ResolveParametersOptions = {}

Resolution options

Returns

Promise<ResolvedParameters>

Resolved parameters, missing parameters, and any errors

Released under the Apache-2.0 License.