#Interface: ApiTemplateDataParam

Defined in: extensions/templatedata.ts:64

One parameter description (params.<name>).

#Properties

#aliases?

optional aliases?: string[]

Defined in: extensions/templatedata.ts:84

Other names this parameter answers to.

---

#autovalue?

optional autovalue?: string | null

Defined in: extensions/templatedata.ts:90

Value auto-inserted when the parameter is used, e.g. {{subst:CURRENTYEAR}}.

---

#default?

optional default?: ApiTemplateDataText | null

Defined in: extensions/templatedata.ts:93

Assumed value when the parameter is absent from a transclusion.

---

#deprecated?

optional deprecated?: string | boolean

Defined in: extensions/templatedata.ts:81

Discouraged. Either a boolean or, better, the text explaining what to use instead.

---

#description?

optional description?: ApiTemplateDataText | null

Defined in: extensions/templatedata.ts:69

Longer explanation shown to editors.

---

#example?

optional example?: ApiTemplateDataText | null

Defined in: extensions/templatedata.ts:99

Example value shown to help editors.

---

#label?

optional label?: ApiTemplateDataText | null

Defined in: extensions/templatedata.ts:66

Display label.

---

#required?

optional required?: boolean

Defined in: extensions/templatedata.ts:72

The template does not work without it. Defaults to false.

---

#suggested?

optional suggested?: boolean

Defined in: extensions/templatedata.ts:75

Worth filling in but not mandatory. Defaults to false.

---

#suggestedvalues?

optional suggestedvalues?: string[]

Defined in: extensions/templatedata.ts:96

Commonly used values offered as completion; free text stays allowed.

---

#type?

optional type?: TemplateDataType

Defined in: extensions/templatedata.ts:87

Expected kind of the value.