A variable representing a name / value pair.


Name @id Type Description Inherited from
name schema:name string The name of the variable. See note 1. Variable
id schema:id string The identifier for this item. Entity
isReadonly schema:readonlyValue boolean Whether or not a property is mutable. Default is false. See note 2. Variable
meta stencila:meta object Metadata associated with this item. Entity
validator stencila:validator ValidatorTypes The validator that the value is validated against. Variable
value schema:value Node The value of the variable. Variable


  1. name : This regex allows for snake_case and camelCase names but excludes PascalCase for names.
  2. isReadonly : If isReadonly is true and value is defined then changes to value should not be allowed.

Available as


This documentation was generated from Variable.schema.yaml.