IPublisherVariableDefinitionV1
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A custom variable declared by document content and given a value by a document.
export interface IPublisherVariableDefinitionV1
Remarks
Referenced from text as {name}. Values come from IPublisherDocumentBaseV1.variableValues, falling back to IPublisherVariableDefinitionV1.defaultValue.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (ALPHA) (Optional) Value used when the document does not provide one. May not contain further placeholders — there is no recursive expansion. | ||
string | (ALPHA) (Optional) | ||
string | (ALPHA) Variable name as used inside the | ||
string | (ALPHA) (Optional) Human readable label shown in the editor. |
Property details
IPublisherVariableDefinitionV1.defaultValuepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Value used when the document does not provide one. May not contain further placeholders — there is no recursive expansion.
defaultValue?: string;
IPublisherVariableDefinitionV1.descriptionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
description?: string;
IPublisherVariableDefinitionV1.namepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Variable name as used inside the {...} marker. Must match /^[a-zA-Z][a-zA-Z0-9_]*$/. Built-in names (PublisherBuiltInVariableV1) are reserved.
name: string;
IPublisherVariableDefinitionV1.titlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Human readable label shown in the editor.
title?: string;