Rule.io SDK

---

Rule.io SDK / rcml/src / PlaceholderParamSpec

Interface: PlaceholderParamSpec

Defined in: rcml/src/email/placeholder-spec.ts:25

Describes one parameter of a placeholder token.

Properties

allowedValues?

optional allowedValues?: string[]

Defined in: rcml/src/email/placeholder-spec.ts:34

Exhaustive list of literal allowed values for strictly enum-type parameters. Absent when the parameter accepts free-form input or pattern-based values.

---

description

description: string

Defined in: rcml/src/email/placeholder-spec.ts:29

Human-readable description of the parameter.

---

format?

optional format?: string

Defined in: rcml/src/email/placeholder-spec.ts:46

Free-form format hint for non-enum parameters (e.g. 'PHP date format string'). Absent when allowedValues or patterns fully describes the valid inputs.

---

patterns?

optional patterns?: string[]

Defined in: rcml/src/email/placeholder-spec.ts:41

Non-exhaustive list of pattern expressions for parameters that accept structured but parameterised values (e.g. 'in-<count>-days'). Uses <placeholder> notation for variable parts. May coexist with allowedValues when both literal and pattern forms are valid.

---

required

required: boolean

Defined in: rcml/src/email/placeholder-spec.ts:27

true when the parameter must be present.