parameterdefinition.md

@contentful/ecommerce-app-base / ParameterDefinition

Interface: ParameterDefinition

Definition of app configuration parameters

Hierarchy

• ParameterDefinition

Index

Properties

• default
• description
• id
• name
• required
• type

Properties

default

• Optional default: any

Default value

---

description

• description: string

Short description/explanation

---

id

• id: string

Unique id. Used as key in Config object.

---

name

• name: string

Name / Label

---

required

• required: boolean

Whether it is possible without providing a value.

---

type

• type: Symbol | List | Number

Parameter type

• Symbol: Text
• List: List of texts
• Number: Integer