VariableReplacer
Defined in: packages/messaging/src/personalization/variable.replacer.ts:69
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VariableReplacer(
options?):VariableReplacer
Defined in: packages/messaging/src/personalization/variable.replacer.ts:81
Parameters
Section titled “Parameters”options?
Section titled “options?”Partial<VariableReplacementOptions> = {}
Returns
Section titled “Returns”VariableReplacer
Methods
Section titled “Methods”extractVariables()
Section titled “extractVariables()”extractVariables(
content):string[]
Defined in: packages/messaging/src/personalization/variable.replacer.ts:154
Extract variables from content without replacing
Parameters
Section titled “Parameters”content
Section titled “content”string
Returns
Section titled “Returns”string[]
preview()
Section titled “preview()”preview(
content,variables):object
Defined in: packages/messaging/src/personalization/variable.replacer.ts:246
Preview replacement result without actually replacing
Parameters
Section titled “Parameters”content
Section titled “content”string
variables
Section titled “variables”Returns
Section titled “Returns”object
originalContent
Section titled “originalContent”originalContent:
string
previewContent
Section titled “previewContent”previewContent:
string
variableHighlights
Section titled “variableHighlights”variableHighlights:
object[]
replace()
Section titled “replace()”replace(
content,variables):ReplacementResult
Defined in: packages/messaging/src/personalization/variable.replacer.ts:88
Replace variables in content
Parameters
Section titled “Parameters”content
Section titled “content”string
variables
Section titled “variables”Returns
Section titled “Returns”ReplacementResult
validate()
Section titled “validate()”validate(
content,variables):object
Defined in: packages/messaging/src/personalization/variable.replacer.ts:207
Validate that all required variables are provided
Parameters
Section titled “Parameters”content
Section titled “content”string
variables
Section titled “variables”Returns
Section titled “Returns”object
errors
Section titled “errors”errors:
ReplacementError[]
isValid
Section titled “isValid”isValid:
boolean
missingVariables
Section titled “missingVariables”missingVariables:
string[]