Variable
A variable representing a name / value pair.
This schema type is marked as experimental 🧪 and is subject to change.
Properties#
| 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 |
Notes#
- name : !array('This regex allows for snake_case and camelCase names but excludes PascalCase for names.')
- isReadonly : !array('If ')
isReadonly!array(' is ')true!array(' and ')value!array(' is defined then changes to ')value!array(' should not be allowed.')
Related#
Available as#
- JSON-LD
- JSON Schema
- Python
class Variable - TypeScript
interface Variable - R
class Variable - Rust
struct Variable
Source#
This documentation was generated from Variable.schema.yaml.