---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [scaffold](../index.md) / ScaffoldParameter

# Interface: ScaffoldParameter

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:63](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L63)

Parameter definition for scaffold prompts and flags

## Properties

### choices?

> `optional` **choices**: [`ScaffoldChoice`](ScaffoldChoice.md)[]

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:79](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L79)

Available choices for choice/multi-choice types

***

### default?

> `optional` **default**: `string` \| `boolean` \| `string`[]

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:73](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L73)

Default value if not provided

***

### flag?

> `optional` **flag**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L81)

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

***

### name

> **name**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:65](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L65)

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

***

### pattern?

> `optional` **pattern**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:75](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L75)

Regex pattern for validation (string types only)

***

### prompt

> **prompt**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:67](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L67)

Prompt message shown in interactive mode

***

### required

> **required**: `boolean`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:71](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L71)

Whether this parameter is required

***

### source?

> `optional` **source**: [`DynamicParameterSource`](../type-aliases/DynamicParameterSource.md)

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:85](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L85)

Dynamic source for populating choices at runtime

***

### type

> **type**: [`ScaffoldParameterType`](../type-aliases/ScaffoldParameterType.md)

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:69](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L69)

Type of the parameter

***

### validationMessage?

> `optional` **validationMessage**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:77](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L77)

Error message shown when validation fails

***

### when?

> `optional` **when**: `string`

Defined in: [packages/b2c-tooling-sdk/src/scaffold/types.ts:83](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/e7c16f1ae423da0aa47b3e10be88f9770b53619b/packages/b2c-tooling-sdk/src/scaffold/types.ts#L83)

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