WriteTemplateExtension
Defined in: runtime/extension.ts:23
Property extensions for a given template and parent item.
Extends
Section titled “Extends”Properties
Section titled “Properties”definition
Section titled “definition”
readonlydefinition:TemplateDefinition
Defined in: runtime/extension.ts:15
Inherited from
Section titled “Inherited from”ReadTemplateExtension.definition
readonlyprn:string
Defined in: runtime/extension.ts:17
Inherited from
Section titled “Inherited from”properties
Section titled “properties”
readonlyproperties:Record<string,PropertyDefinition>
Defined in: runtime/extension.ts:16
Inherited from
Section titled “Inherited from”ReadTemplateExtension.properties
Methods
Section titled “Methods”Call Signature
Section titled “Call Signature”add(
key,type,options?):PropertyBuilder
Defined in: runtime/extension.ts:28
Adds a data type property of the given type to the payload for this transition.
Parameters
Section titled “Parameters”string
PrimitiveDataType | TemporalDataType
options?
Section titled “options?”Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”add(
key,type,options?):SelectPropertyBuilder
Defined in: runtime/extension.ts:29
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Call Signature
Section titled “Call Signature”add(
key,type,options?):unknown
Defined in: runtime/extension.ts:30
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”unknown
remove()
Section titled “remove()”remove(
key):this
Defined in: runtime/extension.ts:35
Removes the given property defined by the key.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
set(
definition):this
Defined in: runtime/extension.ts:40
Allows the direct setting of a property based on the definition.
Parameters
Section titled “Parameters”definition
Section titled “definition”Returns
Section titled “Returns”this
update()
Section titled “update()”update():
Promise<WriteTemplateExtension>
Defined in: runtime/extension.ts:45
Updates any changes to this template.
Returns
Section titled “Returns”Promise<WriteTemplateExtension>