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

Interface: ScaffoldParameter

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:63

Parameter definition for scaffold prompts and flags

Properties

choices?

optional choices: ScaffoldChoice[]

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:79

Available choices for choice/multi-choice types

---

default?

optional default: string | boolean | string[]

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:73

Default value if not provided

---

flag?

optional flag: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:81

CLI flag name override (e.g., "--name"). If not set, uses --

---

name

name: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:65

Parameter name (camelCase), used in templates as variable name

---

pattern?

optional pattern: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:75

Regex pattern for validation (string types only)

---

prompt

prompt: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:67

Prompt message shown in interactive mode

---

required

required: boolean

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:71

Whether this parameter is required

---

source?

optional source: DynamicParameterSource

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:85

Dynamic source for populating choices at runtime

---

type

type: ScaffoldParameterType

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:69

Type of the parameter

---

validationMessage?

optional validationMessage: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:77

Error message shown when validation fails

---

when?

optional when: string

Defined in: packages/b2c-tooling-sdk/src/scaffold/types.ts:83

Conditional expression: only prompt if condition is met (e.g., "otherParam=value")